GtDio6xStepGetCount

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns the number of valid steps.

Syntax

GtDio6xStepGetCount (nHandle, plStepCount, 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
PSLONG
The number of defined Steps, range is 0-4095.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

This function returns the number of defined Steps in the Domain memory.

Calling GtDio6xStepGetDefinedSteps API will return the count and list of Steps defined and each Step’s Vector Count.

Example

The following example sets the number of valid steps to 5, and returns the settings:

 

SHORT   nStatus;

LONG    lStepCount;

 

GtDio6xStepSetCount (nHandle, 5, &nStatus);

GtDio6xStepGetCount (nHandle, &lStepCount, &nStatus);

 

See Also

GtDio6xStepSetVectorCount, GtDio6xStepGetVectorCount, GtDio6xGetErrorString