niDCPower_ConfigurePulseCurrentLevel
- Updated2023-04-15
- 2 minute(s) read
ViStatus niDCPower_ConfigurePulseCurrentLevel(ViSession vi, ViConstString channelName, ViReal64 level);
Purpose
Configures the pulse current level that the specified channel(s) attempt to generate during the on phase of a pulse. 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 output channel. The pulse current level setting is applicable only if the channel is set to the NIDCPOWER_VAL_PULSE_CURRENT output function using the niDCPower_ConfigureOutputEnabled function.
Channels actively regulate the current at the specified level unless doing so causes a voltage drop greater than the pulse voltage limit across the channels' output terminals.
 |
Note This function is not supported on all devices. Refer to Supported Functions by Device for more information about supported devices. |
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. |
| level | ViReal64 | Specifies the pulse current level, in amps, on the specified channel(s). Valid Values: The valid values for this parameter are defined by the pulse current level range that is configured using the niDCPower_ConfigureCurrentPulseLevelRange function. |
Return Value
| Name | Type | Description |
| Status | ViStatus | Reports 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. |