GxSmuSourceGetCurrentLimit

Applies To

GX3104

Purpose

Returns the specified channel’s current limit settings when in constant voltage mode.

Syntax

GxSmuSourceGetCurrentLimit (nHandle, nChannel, pdCurrentLimit, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX3104 board.
nChannel
SHORT
Specifies the channel number (0-3):
GX3104_CHANNEL_1
GX3104_CHANNEL_2
GX3104_CHANNEL_3
GX3104_CHANNEL_4
pdCurrentlimit
PDOUBLE
Returns the specified channel’s current settings, the range for each current range is as follows:
0.      GX3104_SOURCE_CURRENT_RANGE_1000MA: Source Current Range +/-1000mA. Supported by channel 1 only, channels 2-4 can be set up to +/-500mA.
1.      GX3104_SOURCE_CURRENT_RANGE_250MA: Source Current Range +/250mA.
2.      GX3104_SOURCE_CURRENT_RANGE_25MA: Source Current Range +/-25mA (default after reset).
3.      GX3104_SOURCE_CURRENT_RANGE_2500UA: Source Current Range +/-2.5mA
4.      GX3104_SOURCE_CURRENT_RANGE_250UA: Source Current Range +/-250uA
5.      GX3104_SOURCE_CURRENT_RANGE_25UA: Source Current Range +/-25uA+/
6.    GX3104_SOURCE_CURRENT_RANGE_2500NA: Source Current Range -2.5uA to -1uA, and 1uA to 2.5uA
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function returns the specified channel’s current settings. The returned current value is in mA.

Example

The following example returns channel 1 current limit settings

 

SHORT nStatus;

DOUBLE dCurrentLimit;

GxSmuSourceGetCurrentLimit (nHandle, GX3104_CHANNEL_1, &dCurrentLimit, &nStatus);

 

See Also

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