GtWaveGetBoardSummary

Supported By

GX1110, GX1120

Purpose

Returns the board information.

Syntax

GtWaveGetBoardSummary (nHandle, szSummary, nSumMaxLen, pnStatus)

Parameters

Name
Type
Comments

nHandle

SHORT
Handle to a GX11X0 board.
szSummary
PSTR
Buffer to contain the returned board info (null terminated) string.
nSumMaxLen
SHORT
Size of the buffer to contain the error string.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The board summary string provides the following data from the board in the order shown:

For example, the returned string could look like the following:

“GtWave, FPGA-Version:0xB000, Serial Number: GtWave0005-BB-BA-0000, Calibrated on: Sat Feb 23 23:36:14 2008”

Example

The following example returns the board summary:

 

SHORT nHandle, nStatus;

CHAR szSummary [256];

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

 

See Also

GtWaveGetDriverSummary, GtWaveInitialize, GtWaveGetErrorString