niDCPower_CalAdjustCurrentLimit
- Updated2025-10-06
- 2 minute(s) read
Calculates the calibration constants for the current limit for the specified channel and range. This function compares the array in requestedOutputs to the array in measuredOutputs and calculates the calibration constants for the current limit returned by the device. Refer to the calibration procedure for the device you are calibrating for detailed instructions on the appropriate use of this function. This function can only be called from an external calibration session.
Syntax
ViStatus _VI_FUNC niDCPower_CalAdjustCurrentLimit(ViSession vi, ViConstString channelName, ViReal64 range, ViUInt32 numberOfMeasurements, const ViReal64 requestedOutputs[], const ViReal64 measuredOutputs[])
Remarks
NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.
This function is not supported on all devices. Refer to Supported Functions by Device for more information about supported devices.
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| vi | [in] | ViSession | Identifies a particular instrument calibration session. vi is obtained from the niDCPower_InitExtCal function. |
| channelName | [in] | ViConstString | Specifies the channel name to which these calibration settings apply. |
| range | [in] | ViReal64 | Specifies the range to calibrate with these settings. Only one channel at a time may be calibrated. |
| numberOfMeasurements | [in] | ViUInt32 | Specifies the number of elements in requestedOutputs and measuredOutputs. |
| requestedOutputs | [in] | const ViReal64[] | Specifies an array of the output values that were requested in the niDCPower_ConfigureCurrentLimit function. |
| measuredOutputs | [in] | const ViReal64[] | Specifies an array of the output values measured by an external precision digital multimeter. |
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 |