GtDio6xStepGetRecordMode

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns a Step’s Record Mode.

Syntax

GtDio6xStepGetRecordMode (nHandle, lStep, pnMode, 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.

●     File handle is used when communicating with a file. The File handle session identifier is  returned by calling GtDio6xFileOpen.
lStep
LONG
Step Number to access 0-4095.
pnMode
PSHORT
Returns the Record mode for the specified step:

0. GTDIO6X_STEP_RECORD_MODE_DISABLED: All three record memories are disabled. The record memory does not records any incoming data. The record memory can either be set to record all zeros (No Error) or disabled using the GtDio6xSequencerSetRecordParameters API.

1. GTDIO6X_STEP_RECORD_MODE_RTC_COUNT_ADDRESS: The Error Count and Error Address Memory are enabled (See comments). The record memory does not record any incoming data. The record memory can either be set to record all zeros (No Error) or disabled using the GtDio6xSequencerSetRecordParameters API.

2. GTDIO6X_STEP_RECORD_MODE_RTC: All three memories are enabled, the Error Count and the Error Address Memory, the Record Index Memory and the Record Memory. The Record Memory is set to record real time record data.

3. GTDIO6X_STEP_RECORD_MODE_RESPONSE: All three memories are enabled. All three memories are enabled, the Error Count and the Error Address Memory, the Record Index Memory and the Record Memory. The Record Memory is set to record response data.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

There are three memories that stores error data from sequence burst:

●     Error Counter and Error Address Memory: The Error Address Memory stores the sequence step, address and index of each vector that generated an error.  The Error Address Memory can be queried using the GtDio6xRealTimeCompareReadErrorAddressMemory function.

●     Record Index Memory: The Record Index Memory contains the data required to align the record memory contents when data is stored sequentially (Record Type = Indexed), use the GtDio6xReadRecordIndexMemory API.

●     Record Memory: The Record Memory contains either the error or response data for the previous sequence burst. Use GtDio6xReadRecordMemory API.

Example

The following sets the record mode of sequence step 5 to response, and returns the settings:

 

SHORT nStatus;

SHORT nRecordMode;

 

GtDio6xStepSetRecordMode(nHandle, 5, GTDIO6X_RECORD_MODE_RESPONSE, &nStatus);

GtDio6xStepGetRecordMode(nHandle, 5, &nRecordMode, &nStatus);

 

See Also

GtDio6xStepSetRecordMode, GtDio6xRealTimeCompareReadErrorAddressMemory, GtDio6xRealTimeCompareGetErrorCount,  GtDio6xSequencerSetRecordParameters, GtDio6xGetErrorString