GtDio6xGetBoardSummary

GX5296, GX5961, GX5964

Returns the board information

GtDio6xGetBoardSummary (nHandle, pszSummary, nSumMaxLen, 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.
pszSummary	PSTR	Buffer to contain the returned board summary (null terminated) string.
nSumMaxLen	SHORT	Size of the buffer to contain the board summary string.
pnStatus	PSHORT	Returned status: 0 on success, negative number on failure.

The GTDIO6X board summary string provides information about the board. The following example is the returned board summery for a GX5964 master board:

“GX5964:Advanced DIO Board, Altera FPGA-Version:0x0400, Xilinx FPGA-Version:0x3, S/N:GX59640021BA-BA-00”.

The following example returns the board summary:

SHORT nHandle, nStatus;

CHAR szSummary [1024];

GtDio6xGetBoardSummary(nHandle, szSummary, sizeof(szSummary), &nStatus);

printf(“The board summary is: %s”, szSummary);