GtDio6xProbeGetDataMode

Applies To

GX5961

Purpose

Returns the probe’s data mode.

Syntax

GtDio6xProbeGetDataMode (nHandle, pnProbeDataMode, pnStatus)

Parameters

Name
Type
Comments

nHandle

SHORT

Session identifier:

     Board handle is used when communicating with the hardware. The Board handle session identifier is returned by calling GtDio6xInitialize or GtDio6xSetupInitialization.

pnProbeDataMode

PSHORT

Used to return the probe data mode.

0.  GTDIO6X_PROBE_DATA_DISABLE: Probe Data Memory is not written.

1.  GTDIO6X_PROBE_DATA_ENABLE: Probe Data Memory will be written to at the end of each vector.

pnStatus

PSHORT

Returned status: 0 on success, negative value on failure.

Comments

The probe data mode controls the writing of probe results in to the probe data memory.

If disabled, the probe data memory is not written to. If enabled, the probe results are written to the probe data memory at the end of each vector.

Example

The following example enables the probe’s data mode, and returns the settings:

 

SHORT nProbeMode;

 

GtDio6xProbeSetDataMode(nHandle, GTDIO6X_PROBE_DATA_ENABLE, &nStatus);

GtDio6xProbeGetDataMode(nHandle, &nProbeMode, &nStatus);

 

See Also

GtDio6xProbeSetDataMode, GtDio6xProbeSetParameters, GtDio6xProbeGetParameters, GtDio6xWriteVectorMemory, GtDio6xReadVectorMemory, GtDio6xGetErrorString