niDCPower_QueryMaxCurrentLimit

NI-DCPower Function Reference

niDCPower_QueryMaxCurrentLimit

ViStatus niDCPower_QueryMaxCurrentLimit (ViSession vi, ViConstString channelName, ViReal64 voltageLevel, ViReal64 *maxCurrentLimit);

Purpose

Queries the maximum current limit on an output channel if the output channel is set to the specified voltageLevel.

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 the output channel to query. The maximum current limit may only be queried for one channel at a time.
voltageLevel ViReal64 Specifies the voltage level to use when calculating the maxCurrentLimit.
Output
Name Type Description
maxCurrentLimit ViReal64* Returns the maximum current limit that can be set with the specified voltageLevel.

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.