GtDio6xFileGroupDelete

Applies To

File

Purpose

Delete the specified group’s name, and the group’s channels names string from the file.

Syntax

GtDio6xFileGroupDelete (hFile, pszGroupName, pnStatus)

Parameters

Name
Type
Comments
hFile
SHORT
Session identifier: File handle is used when communicating with a file. The File handle session identifier is returned by calling GtDio6xFileOpen.
pszGroupName
PCSTR
String specifying group name.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function deletes the specified group’s name, and the group’s channels names string from the file. If the string specifying group name does not exists the function retunes an error.

See GtDio6xFileGroupGetChannelList() for complete example code:

Example

The following example deletes the group “Group1” and the group’s channels names string from the file

 

SHORT hFile, nStatus;

GtDio6xFileGroupDelete (hFile, “Group1”, &nStatus);

 

See Also

GtDio6xFileOpen, GtDio6xFileSave, GtDio6xFileGroupGet, GtDio6xFileGroupGetChannelList, GtDio6xFileGroupGetName, GtDio6xFileGroupSet ,GtDio6xGetErrorString