GtDio6xChannelResetNames

Applies To

GX5296, GX5961, GX5964, File

Purpose

Resets all the channel’s names to default.

Syntax

GtDio6xChannelResetNames (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

Reset all the channel’s names back to default. The default channels’ name format is “CHXX”, e.g. channel 0 name will be set to “CH0”.

An I/O Channel can be associated with a unique 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 channels names, retrieve channel’s 0 name and then uses the name to retrieve back the channel index:

 

SHORT nStatus;

LONG lChannel;

CHAR  szChannelName[256];

 

GtDio6xChannelResetNames(nHandle, &nStatus);

GtDio6xChannelSetName(nHandle, 0, szChannelName, 256 &nStatus);

printf(“Channel 0 name is: %s”, szChannelName);

 

GtDio6xChannelGetNameIndex (nHandle, szChannelName, &lChannel, pnStatus);

 

See Also

GtDio6xChannelGetName, GtDio6xChannelGetNameIndex, GtDio6xGetErrorString