GxSmuIsInCompliance

Applies To

GX3104

Purpose

Returns if the specified channel is operating at the compliance limit.

Syntax

GxSmuIsInCompliance (nHandle, nChannel, pnComplianceLimit, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX3104 board.
nChannel
SHORT
GX3104: Specifies the channel number (0-3): GX3104_CHANNEL_1 to GX3104_CHANNEL_4  
pnComplianceLimit
PSHORT
Returns 1 if the specified channel is operating at the compliance limit, otherwise returns 0.
In Constant Voltage Mode: Compliance limit = current limit, compliance limit is true if output reaches the current limit before the desired voltage level.
In Constant Current Mode: Compliance limit = voltage limit, compliance limit is true if output reaches the voltage limit before the desired current level.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Returns if the specified channel is operating at the compliance limit.

Example

The following example return the compliance state of channel 1:

 

SHORT nHandle, nStatus;

GxSmuIsInCompliance (nHandle, GX3104_CHANNEL_1, &nComplianceLimit, &nStatus);

 

See Also

GxSmuMeasure, GxSmuSourceSetCurrentLimit, GxSmuSourceSetCurrentClamps, GxSmuSourceSetVoltageLimit, GxSmuSourceSetRangeMode, GxSmuGetErrorString, GxSmuReset