Discovers if an output cutoff limit was exceeded for the specified reason.

Syntax

Namespace: NationalInstruments.ModularInstruments.NIDCPower

public bool QueryLatchedOutputCutoffState(string channelString, DCPowerOutputCutoffReason 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 method or the Reset method.

outputCutoffReason specifies the conditions for which an output is disconnected.

Note

NI-DCPower uses the terms "source" and "output". However, while sinking with electronic loads and SMUs these correspond to "sinking" and "input", respectively.

Note

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.

Parameters

NameTypeDescription
channelStringstring

Specifies the 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.

outputCutoffReasonDCPowerOutputCutoffReason

Specifies which output cutoff conditions to query.

Returns

Returns whether output from the specified channel(s) has been cut off due to the specified outputCutoffReason.