niDCPower_ConfigureCurrentLevel

NI-DCPower Function Reference

niDCPower_ConfigureCurrentLevel

ViStatus niDCPower_ConfigureCurrentLevel (ViSession vi, ViConstString channelName, ViReal64 level);

Purpose

Configures the current level the device attempts to generate for the specified channel(s). The channel must be enabled for the specified current level to take effect. Refer to the niDCPower_ConfigureOutputEnabled function for more information about enabling the output channel.

The current level setting is applicable only if the channel is set to the NIDCPOWER_VAL_DC_CURRENT output function using the niDCPower_ConfigureOutputFunction function. The device actively regulates the current at the specified level unless doing so causes a voltage greater than the voltage limit across the channels' output terminals.

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.
level ViReal64 Specifies the current level, in amps, to generate for the specified channel(s).

Valid Values:
The valid values for this parameter are defined by the current level range that is configured using the niDCPower_ConfigureCurrentLevelRange function.

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.