GtDio6xReadRecordIndexMemory

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns the record index memory contents.

Syntax

GtDio6xReadRecordIndexMemory (nHandle, dwIndexArraySize, panIndexStepArray, padwIndexVectorArray, 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.

dwIndexArraySize
DWORD
Used to specify the number of Record Index Memory states that will be read.
panIndexStepArray
PSHORT
Returns an array of Steps that were recorded.
padwIndexVectorArray
PDWORD
Returns an array of Vectors that were recorded.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

This function will read the Record Index memory. This function should be used when the Record Type is set to indexed mode using the GtDio6xSequencerSetRecordParameters function.

If the Record Type was set to GTDIO6X_RECORD_INDEXED_SEQUENTIAL using GtDio6xSequencerSetRecordParameters function then the record index memory stores the sequence step and pattern index of the first 1024 steps of a sequence execution. The record index memory allows the user to determine sequence step order that filled the record memory. Data stored in the record memory will begin at offset 0. The record index memory contains the information to align the record memory with the sequence step data.

Example

The following example gets 1024 elements of record index memory:

 

SHORT anIndexStepArray[1024];

DWORD adwIndexVectorArray[1024];

BYTE  aucRecordData[1024];

SHORT nStatus;

 

GtDio6xReadRecordMemory(nHandle, 32, alChannelList, 0, 1024, aucRecordData, &nStatus);

GtDio6xReadRecordIndexMemory(nHandle, 1024, anIndexStepArray, adwIndexVectorArray, &nStatus);

printf(“The recorded data stored in address 204 of the record memory was generated by Vector %d of Step %d”, adwIndexVectorArray[204], anIndexStepArray[204]); 

 

See Also

GtDio6xSequencerSetRecordParameters