niDCPower_ConfigureCurrentLevel
- Updated2025-10-06
- 2 minute(s) read
Configures the current level that the specified channel(s) attempt to generate. A channel must be enabled for the specified current level to take effect. Refer to the niDCPower_ConfigureOutputEnabled function for more information about enabling the channel.
Syntax
ViStatus _VI_FUNC niDCPower_ConfigureCurrentLevel(ViSession vi, ViConstString channelName, ViReal64 level)
Remarks
The current level setting is applicable only if the output function of the channel is set to NIDCPOWER_VAL_DC_CURRENT. Use niDCPower_ConfigureOutputFunction to set the output function. Channels actively regulate the current at the specified level unless doing so causes a voltage greater than the voltage limit (niDCPower_ConfigureVoltageLimit) across the channels' output terminals.
NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| 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. |
| level | [in] | ViReal64 | Specifies the current level, in amps, to generate for the specified channel(s). Valid Values: |
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 |