GX5296, GX5961, GX5964, File
Sets a Step’s name.
GtDio6xStepSetName (nHandle, lStep, pszName, nNameMaxLen, pnStatus)
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. |
pszName |
PSTR |
Used to specify the name of a sequence step. |
nNameMaxLen |
SHORT |
The maximum length of the pszName buffer. |
pnStatus |
PSHORT |
Returned status: 0 on success, negative value on failure. |
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.
The following example sets the name of step 4 to “My Test”, and return the step’s name:
SHORT nStatus;
CHAR szName[256];
GtDio6xStepSetName(nHandle, 4, “My Test”, 256, &nStatus);
GtDio6xStepGetName(nHandle, 4, pszName, 256, &nStatus);
printf(“Step 4 name is: %s”, pszName);