niDCPower_ConfigureCurrentLevelRange

NI-DCPower Function Reference

niDCPower_ConfigureCurrentLevelRange

ViStatus niDCPower_ConfigureCurrentLevelRange (ViSession vi, ViConstString channelName, ViReal64 range);

Purpose

Configures the current level range for the specified channel(s). The configured range defines the valid values the current level can be set to using the niDCPower_ConfigureCurrentLevel function. The current level range setting is applicable only if the channel is set to the NIDCPOWER_VAL_DC_CURRENT output function using the niDCPower_ConfigureOutputFunction function.

Use the NIDCPOWER_ATTR_CURRENT_LEVEL_AUTORANGE attribute to enable automatic selection of the current level range.

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.
range ViReal64 Specifies the current level range, in amps, for the specified channel.

Valid Values:

NI PXI-4110
ChannelCurrent Level RangeCurrent Level
01 A+0.01 to +1 A
120 mA+0.20 to +20 mA
1 A+0.01 to +1 A
220 mA-0.20 to -20 mA
1 A-0.01 to -1 A

NI PXI-4130
ChannelCurrent Level RangeCurrent Level
01 A+0.02 to +1 A
1200 μA +4 to +200 μA and -4 to -200 μA
2 mA+0.04 to +2 mA and -0.04 to -2 mA
20 mA+0.40 to +20 mA and -0.40 to -20 mA
200 mA+4 to +200 mA and -4 to -200 mA
2 A+0.04 to +2 A and -0.04 to -2 A
Note Note   If a range other than what is listed in the preceding table is selected, it will be coerced to the next-highest range. For example, requesting the 100 mA current level range on Channel 1 on the NI-PXI 4130 coerces the current level range to 200 mA. Refer to the Ranges topic in the NI DC Power Supplies and SMUs Help for more information about coercion.

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.