Enables or disables generation on the specified channel(s).

Syntax

ViStatus _VI_FUNC niDCPower_ConfigureOutputEnabled(ViSession vi, ViConstString channelName, ViBoolean enabled)

Remarks

Depending on the selected output function, the corresponding level properties or NIDCPOWER_ATTR_OUTPUT_RESISTANCE must be set in addition to enabling the output to generate the desired level. For more information about configuring the output level, refer to niDCPower_ConfigureOutputFunction .

Note

If a channel is in the Uncommitted state, enabling the output does not take effect until you call the niDCPower_InitiateWithChannels function.

Note

NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.

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

Specifies whether the channels are enabled or disabled.

Defined Values:

VI_TRUE

Enables generation on the specified channel(s).

VI_FALSE

Disables generation on the specified channel(s). This parameter has no effect on the output disconnect relay. To toggle the relay, use the NIDCPOWER_ATTR_OUTPUT_CONNECTED attribute.

The default value is VI_TRUE if you use the niDCPower_InitializeWithIndependentChannels function to open the session. Otherwise the default value is VI_FALSE, including when you use a calibration session.

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