GtDio6xGetBoardCount

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns the number of boards in the domain.

Syntax

GtDio6xGetBoardCount (nHandle, pnBoardCount,, 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.
pnBoardCount
PSHORT
Used to return the number of boards in the domain.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The number of boards in the domain is determined by the user when calling GtDio6xSetupInitialization or the INI configuration file when calling GtDio6xInitialize. After the domain is initialized the used can call this function to get the number of boards in the domain. By calling GtDio6xGetBoardInfo and GtDio6xGetBoardType the user can get additional information about the domain configuration.

Example

The following example gets the board count:

 

SHORT nHandle, nBoardCount;

SHORT nStatus;

 

GtDio6xGetBoardCOunt(nHandle, &nBoardCount, &nStatus);

printf(“There are %d boards in the domain”, nBoardCount);

See Also

GtDio6xInitialize, GtDio6xSetupInitialization, GtDio6xGetBoardInfo, GtDio6xGetBoardType, GtDio6xGetErrorString