GxSmuSourceGetCurrentClamps

Applies To

GX3116e

Purpose

Returns the specified channel’s programmed current clamps source and sink settings when in constant voltage mode.

Syntax

GxSmuSourceGetCurrentClamps (nHandle, nChannel, pdCurrentClampSource, pdCurrentClampSink, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX3116e board.
nChannel
SHORT
Specifies the channel number (0-15): GX3116_CHANNEL_1 - GX3116_CHANNEL_16
pdCurrentClampSource
PDOUBLE
Returns the specified channel’s programmed current clamps source settings in mA when in constant voltage mode, according to the programmed current range.
0.      GX3116_SOURCE_CURRENT_RANGE_512MA: Source Current Range -75mA to 650mA
1.      GX3116_SOURCE_CURRENT_RANGE_25_POINT_6MA: Source Current Range 7.5mA to 30mA (default)
2.    GX3116_SOURCE_CURRENT_RANGE_2_POINT_56MA: Source Current Range 1mA to 3mA
pdCurrentClampSink
PDOUBLE
Returns the specified channel’s programmed current clamps sink settings in mA when in constant voltage mode, according to the programmed current range.
0.      GX3116_SOURCE_CURRENT_RANGE_512MA: Source Current Range 75mA to 650mA
1.      GX3116_SOURCE_CURRENT_RANGE_25_POINT_6MA: Source Current Range 7.5mA to 30mA (default)
2.    GX3116_SOURCE_CURRENT_RANGE_2_POINT_56MA: Source Current Range 1mA to 3.0mA
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function returns the returns the specified channel’s programmed current clamps source and sink settings in mA when in constant voltage mode.

The user can call the GxSmuGetStatusRegisterChannel() API at any time, in order to find out if at any time the limits were met.

Example

The following example sets ch 1 current range to +/-512mA, sets current clamps and returns the specified channel’s programmed current clamps source and sink settings when in constant voltage mode:

 

SHORT nStatus;

DOUBLE dCurrentClampSource, &dCurrentClampSink;

GxSmuSourceSetCurrentRange (nHandle, GX3116_CHANNEL_1, GX3116_SOURCE_CURRENT_RANGE_512MA, &nStatus);

GxSmuSourceSetCurrentClamps (nHandle, GX3116_CHANNEL_1, 200.0, 150.0, &nStatus);

GxSmuSourceGetCurrentClamps (nHandle, GX3116_CHANNEL_1, &dCurrentClampSource, &dCurrentClampSink, &nStatus);

 

See Also

GxSmuSourceSetCurrent, GxSmuSourceSetCurrentLimit, GxSmuSourceSetCurrentClamps, GxSmuSourceSetCurrentRange, GxSmuSourceSetMode, GxSmuSourceSetOutputState, GxSmuSourceSetRangeMode, GxSmuSourceSetVoltage, GxSmuSourceSetVoltageLimit, GxSmuGetErrorString