niDCPower_QueryInCompliance
ViStatus niDCPower_QueryInCompliance(ViSession vi, ViConstString channelName, ViBoolean *inCompliance);
Purpose
Queries the device to indicate if the output is operating at the compliance limit.
The compliance limit is the current limit when the output function is set to NIDCPOWER_VAL_DC_VOLTAGE. If the output is operating at the compliance limit, the output reaches the current limit before the desired voltage level. Refer to the niDCPower_ConfigureOutputFunction function and the niDCPower_ConfigureCurrentLimit function for more information about output function and current limit, respectively.
The compliance limit is the voltage limit when the output function is set to NIDCPOWER_VAL_DC_CURRENT. If the output is operating at the compliance limit, the output reaches the voltage limit before the desired current level. Refer to the niDCPower_ConfigureOutputFunction function and the niDCPower_ConfigureVoltageLimit function for more information about output function and voltage limit, respectively.
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. Compliance status can only be queried for one channel at a time. |
| Output | ||
| Name | Type | Description |
| inCompliance | ViBoolean* | Returns whether the device output channel is in compliance. |
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. |