NI-DCPower C Function Reference Help

niDCPower_ConfigureOutputEnabled

  • Updated2023-04-15
  • 2 minute(s) read

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

Purpose

Enables or disables generation on the specified channel(s). Depending on the selected output function, the voltage level, current level,or 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 Note  If a channel is in the Uncommitted state, enabling the output does not take effect until you call the niDCPower_InitiateWithChannels function.

Parameters

Input
Name Type Description
vi ViSession Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.
channelName 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 ViBoolean Specifies whether the output channels are enabled or disabled.

Defined Values:
VI_TRUEEnables generation on the specified output channel(s).
VI_FALSEDisables generation on the specified output 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.

Return Value

Name Type Description
StatusViStatusReports the status of this operation. To obtain a text description of the status code, call the niDCPower_error_message function. To obtain additional information concerning the error condition, call the niDCPower_GetError function.

Log in to get a better experience