GxSmuMeasureString

Applies To

GX3104, GX3116e

Purpose

Measures the specified channel’s current or voltage and returns a formatted string.

Syntax

GxSmuMeasureString (nHandle, nChannel, nMeasurementSignal, pszMeasurenment, nMeasMaxLen, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX3104 or GX3116e board.
nChannel
SHORT
GX3104: Specifies the channel number (0-3): GX3104_CHANNEL_1 to GX3104_CHANNEL_4
GX3116e: Specifies channel number (0-15) is GX3116_CHANNEL_1 to GX3116_CHANNEL_16.
nMeasurementSignal
SHORT
GX3104:
0.      GXSMU_MEASURE_VOLTAGE: measures voltage in volts.
1.      GXSMU_MEASURE_CURRENT: measures current in mA.
GX3116e:
0.      GXSMU_MEASURE_VOLTAGE: measures voltage in volts.
1.      GXSMU_MEASURE_CURRENT: measures current in mA.
2.      GXSMU_MEASURE_TEMPERATURE_FAHRENHEIT: measures the channel’s temperature in Fahrenheit.
3.    GXSMU_MEASURE_TEMPERATURE_CELSIUS: measures the channel’s temperature in Celsius.  
pszMeasurenment
PCHAR
0.        GxSmu_MEASURE_SENSE_MODE_LOCAL: Local sense measurements using a single set of leads.
1.    GxSmu_MEASURE_SENSE_MODE_REMOTE:  
Remote sense measurements using two sets of leads.
nMeasMaxLen
SHORT
Buffer to the returned driver measurement string.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

This function takes a measurement of the specified channel’s current or voltage, and returned a formatted string with the correct measurement unit.

All Voltage measurements returned with “V”, e.g. “12.34 V”

All Current measurements returned with the current range e.g. “mA”

The parameter pszMeasurement will be set to “0.0” if an error occurs, or if any other warning occurs.

Example

The following example takes a voltage measurement from channel 1:

 

SHORT nHandle, nStatus;

DOUBLE dResult;

CHAR   szResult[256]

GxSmuMeasureString (nHandle, GX3104_CHANNEL_1, GXSMU_MEASURE_VOLTAGE, szResult, sizeof szResult, &nStatus);

 

See Also

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