GtDio6xStepGetDefinedSteps

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns a count and list of Steps defined and each Step’s Vector Count.

Syntax

GtDio6xStepGetDefinedSteps (nHandle, plStepCount, lArraySize, palStepIndex, palStepVectorCount, palStepVectorAddress, 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.

plStepCount
PLONG
The number of defined Steps
lArraySize
LONG
The maximum allowable array size for panStepIndex and palStepVectorCount arrays. The number of elements in panStepIndex and palStepVectorCount must be equal to or less than lArraySize.
palStepIndex
PLONG
Returns an array of the Step indices defined
palStepVectorCount
PLONG
Returns the Vector Count for each step defined
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

This function returns all the defined Steps in the Domain memory.

Example

The following example gets the defined Steps:

 

SHORT   nStatus;

LONG    alStepIndex[100];

LONG    alStepVectorCount[100];

 

GtDio6xStepGetDefinedSteps(nHandle, &lStepCount, 100, alnStepIndex, alStepVectorCount , &nStatus);

 

for(i=0; i<lStepCount; i++)

    printf(“Step %d has %d Vectors associated with it”, alStepIndex[i], alStepVectorCount[i]);

 

See Also

GtDio6xStepSetVectorCount, GtDio6xStepGetVectorCount, GtDio6xGetErrorString