GxSmuMeasureGetPowerLineFrequency

Applies To

GX3104, GX3116e

Purpose

Returns the measurement AC Power Line Frequency settings for all channels.

Syntax

GxSmuMeasureGetPowerLineFrequency (nHandle, pnPowerLineFrequency, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX3104 or GX3116e board.
pnPowerLineFrequency
PSHORT
Measurement AC Power Line Frequency settings. Value can be 10 to 1000.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

This function allows the user to select the line frequency of the Mains Source powering the chassis. Setting this parameter correctly reduces the amount of noise in all measurements.

The last set AC line frequency is stored within the GxSmu.ini file located in Windows Common App Data folder. The input AC line frequency is loaded from the GxSmu.ini file when first initializing the GxSmu after power up, if the file does not exist 60Hz is used. Calling this function will cause the value to be written to the file.

Example

The following example sets the line frequency to 60Hz and returns the settings:

 

SHORT  nHandle, nStatus, nPowerLineFrequency;

 

GxSmuMeasureSetPowerLineFrequency (nHandle, GXSMU_MEASURE_POWER_LINE_FREQUENCY_60HZ, &nStatus);

GxSmuMeasureGetPowerLineFrequency (nHandle, &nPowerLineFrequency, &nStatus);

 

See Also

GxSmuMeasureSetPowerLineFrequency, GxSmuMeasure, GxSmuMeasureSetParamters, GxSmuGetErrorString