niDCPower_QueryLatchedOutputCutoffState
- Updated2023-04-15
- 2 minute(s) read
ViStatus niDCPower_QueryLatchedOutputCutoffState(ViSession vi, ViConstString channelName, ViInt32 outputCutoffReason ViBoolean* outputCutoffState);
Purpose
Discovers if an output cutoff limit was exceeded for the specified reason. When an output cutoff is engaged, the output of the channel(s) is disconnected. If a limit was exceeded, the state is latched until you clear it with niDCPower_ClearLatchedOutputCutoffState or niDCPower_ResetWithChannels.
outputCutoffReason specifies the conditions for which an output is disconnected.
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. |
||||||||||||||||||
| outputCutoffReason | ViInt32 | Specifies which output cutoff conditions to query. Defined Values:
|
||||||||||||||||||
| Output | ||||||||||||||||||||
| Name | Type | Description | ||||||||||||||||||
| outputCutoffState | ViBoolean* | Specifies whether an output cutoff has engaged. Defined Values:
| ||||||||||||||||||
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. |