This function configures the power supply's overvoltage protection. You specify the overvoltage limit and the behavior of the power supply when the output voltage is greater than or equal to that value.

Syntax

ViStatus _VI_FUNC niDCPower_ConfigureOVP(ViSession vi, ViConstString channelName, ViBoolean enabled, ViReal64 limit)

Remarks

When the enabled parameter is FALSE, the limit parameter does not affect the instrument's behavior, and the driver ignores the limit parameter.

Parameters

NameDirectionTypeDescription
vi[in]ViSession

Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.

channelName[in]ViConstString

Specifies the channel(s) to use. Specify the channel(s) using the form PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3 or PXI1Slot3/0,PXI1Slot3/2:3,PXI1Slot4/2:3, where PXI1Slot3 and PXI1Slot4 are instrument resource names and 0, 2, and 3 are channels.

If you pass "" for this control, all channels in the session are used.

enabled[in]ViBoolean

Pass whether you want to enable or disable the OVP limit. The driver uses this value to set the NIDCPOWER_ATTR_OVP_ENABLED attribute. Refer to the attribute documentation for more information.

limit[in]ViReal64

Pass the overvoltage protection limit you want to use. The driver uses this value to set the NIDCPOWER_ATTR_OVP_LIMIT attribute. Refer to the attribute documentation for more information.

Returns

Reports the status of this operation. To obtain a text description of the status code, call niDCPower_error_message. To obtain additional information concerning the error condition, call niDCPower_GetError. The general meaning of the status code is as follows:

Value

Meaning

0

Success

Positive Values

Warnings

Negative Values

Errors