DCPowerMeasurement.QueryLatchedOutputCutoffState Method
- Updated2024-01-04
- 2 minute(s) read

DCPowerMeasurementQueryLatchedOutputCutoffState Method
Discovers if an output cutoff limit was exceeded for the specified reason.
Namespace: NationalInstruments.ModularInstruments.NIDCPower
Assembly: NationalInstruments.ModularInstruments.NIDCPower.Fx45 (in NationalInstruments.ModularInstruments.NIDCPower.Fx45.dll) Version: 2023
Syntax
public bool QueryLatchedOutputCutoffState( string channelString, DCPowerOutputCutoffReason outputCutoffReason )
Public Function QueryLatchedOutputCutoffState ( channelString As String, outputCutoffReason As DCPowerOutputCutoffReason ) As Boolean
Parameters
- channelString
- Type: SystemString
Specifies the output channels to query. 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 do not provide channel(s), all channels in the session are used. - outputCutoffReason
- Type: NationalInstruments.ModularInstruments.NIDCPowerDCPowerOutputCutoffReason
Specifies which output cutoff conditions to query.
Return Value
Type: BooleanReturns whether output from the specified channel(s) has been cut off due to the specified outputCutoffReason.
Remarks
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 the ClearLatchedOutputCutoffState(String, DCPowerOutputCutoffReason) method or the Reset method.
outputCutoffReason specifies the conditions for which an output is disconnected.
![]() |
---|
NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively. |
![]() |
---|
This method is not supported by all instruments. Refer to the Supported Functions by Device topic in the NI DC Power Supplies and SMUs Help for information about supported instruments. |