niDCPower_ConfigureOutputEnabled

NI-DCPower Function Reference

niDCPower_ConfigureOutputEnabled

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 or the current level must be set in addition to enabling the output to generate the desired level. Refer to the niDCPower_ConfigureVoltageLevel function, the niDCPower_ConfigureCurrentLevel function, and the niDCPower_ConfigureOutputFunction function for more information about configuring the desired output level.

Note Note  If the device is in Delayed Configuration mode, enabling the output will not take effect until you call the niDCPower_Initiate function.

Parameters

Input
Name Type Description
vi ViSession Identifies a particular instrument session. vi is obtained from the niDCPower_init or niDCPower_InitWithOptions function.
channelName ViConstString Specifies to which output channel(s) to apply this configuration value. You can specify multiple channels by using a channel list or a channel range. A channel list is a comma (,) separated sequence of channel names (e.g. 0,2 specifies channels 0 and 2). A channel range is a lower bound channel followed by a hyphen (-) or colon (:) followed by an upper bound channel (e.g. 0-2 specifies channels 0, 1, and 2). In Immediate mode, multiple output channel configurations are performed sequentially based on the order specified in this parameter.
enabled ViBoolean Specifies whether the output is enabled or disabled.

Defined Values:
VI_TRUEEnables generation on the specified output channel(s).
VI_FALSEDisables generation on the specified output channel(s).


Default Value: VI_TRUE

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.