GtDio6xStepResetNames

Applies To

GX5296, GX5961, GX5964, File

Purpose

Resets all the Steps’ names to default.

Syntax

GtDio6xStepResetNames (nHandle, 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.

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

Comments

Resets all the Steps’ names to default. The Steps’ default names are in the format of “Step X”, e.g. step 0 name will be “Step 0”.

A sequence step can be associated with an arbitrary name. This name can be set and read from the software front panel as well. The names are saved to file when GtDio6xFileSave is called.

Example

The following example resets all steps names back to default, and returns the step’s 4 name:

 

SHORT nStatus;

CHAR  szName[256];

 

GtDio6xStepResetNames(nHandle, &nStatus);

GtDio6xStepGetName(nHandle, 4, pszName, 256, &nStatus);

printf(“Step 4 name is: %s”, pszName);

 

See Also

GtDio6xStepGetName, GtDio6xGetErrorString