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.

Syntax

ViStatus _VI_FUNC niDCPower_QueryLatchedOutputCutoffState(ViSession vi, ViConstString channelName, ViInt32 outputCutoffReason, ViBoolean *outputCutoffState)

Remarks

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.

Parameters

NameDirectionTypeDescription
vi[in]ViSession

Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.

channelName[in]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[in]ViInt32

Specifies which output cutoff conditions to query.

Defined Values:

Name

Value

Description

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_ALL

-1 (-0x1)

Any/all output cutoff conditions. Any when querying, all when clearing.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_OUTPUT_HIGH

1 (0x1)

The output exceeded the high cutoff limit for voltage output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_OUTPUT_LOW

2 (0x2)

The output fell below the low cutoff limit for voltage output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_CURRENT_MEASURE_HIGH

4 (0x4)

The measured current exceeded the high cutoff limit for current output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_CURRENT_MEASURE_LOW

8 (0x8)

The measured current fell below the low cutoff limit for current output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_CHANGE_HIGH

16 (0x10)

The voltage slew rate increased beyond the positive change cutoff for voltage output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_CHANGE_LOW

32 (0x20)

The voltage slew rate decreased beyond the negative change cutoff for voltage output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_CURRENT_CHANGE_HIGH

64 (0x40)

The current slew rate increased beyond the positive change cutoff for current output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_CURRENT_CHANGE_LOW

128 (0x80)

The current slew rate decreased beyond the negative change cutoff for current output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_SATURATED

256 (0x100)

Not supported.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_CURRENT_SATURATED

512 (0x200)

The measured current saturates the current range.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_MEASURE_HIGH

1024 (0x400)

The measured voltage exceeded the high cutoff limit for voltage output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_MEASURE_LOW

2048 (0x800)

The measured voltage fell below the low cutoff limit for voltage output.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_SELF_TEST_MEASUREMENT_HIGH

4096 (0x1000)

Not supported.

NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_SELF_TEST_MEASUREMENT_LOW

8192 (0x2000)

Not supported.

outputCutoffState[out]ViBoolean *

Specifies whether an output cutoff has engaged.

Defined Values:

VI_TRUE

An output cutoff has engaged for the conditions in

outputCutoffReason.

VI_FALSE

No output cutoff has engaged.

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