niDCPower_ConfigurePulseCurrentLimit

NI DC Power Supplies and SMUs Help (NI-DCPower)

Edition Date: January 2018

Part Number: 370736U-01

View Product Info

DOWNLOAD (Windows Only)


NI-DCPower (English | Japanese)

ViStatus niDCPower_ConfigurePulseCurrentLimit(ViSession vi, ViConstString channelName, ViReal64 limit);

Purpose

Configures the pulse current limit for the specified channel(s). The channel must be enabled for the specified current limit to take effect.

Refer to the niDCPower_ConfigureOutputEnabled function for more information about enabling the output channel. The pulse current limit is the current that the output must not exceed when generating the desired pulse voltage level. The pulse current limit setting is only applicable if the channel is set to the NIDCPOWER_VAL_PULSE_VOLTAGE output function using the niDCPower_ConfigureOutputFunction function.

Note 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_InitializeWithChannels function.
channelName ViConstString Specifies the output channel(s) to which this configuration value applies. Specify multiple channels by using a channel list or a channel range. A channel list is a comma (,) separated sequence of channel names (for example, 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 (for example, 0-2 specifies channels 0, 1, and 2). In the Running state, multiple output channel configurations are performed sequentially based on the order specified in this parameter.
limit ViReal64 Specifies the pulse current limit, in amps, on the specified channel(s). The limit is specified as a positive value, but symmetric positive and negative limits are enforced simultaneously.

Valid Values:
The valid values for this parameter are defined by the pulse current limit range that is configured using the niDCPower_ConfigurePulseCurrentLimitRange 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.

WAS THIS ARTICLE HELPFUL?

Not Helpful