Gx5733GetBoardSummary

Purpose

Returns the board summary.

Syntax

Gx5733GetBoardSummary (nHandle, szSummary, nSumMaxLen, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX5733 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 GX5733 summary string provides the following data:

 

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

 

GX5733, FPGA Version:0xA000, Module: GX5701 FPGA Version:0x000A

 

Example

The following example returns the board summary:

 

SHORT nHandle, nStatus;

CHAR szSummary [256];

Gx5733GetBoardSummary(nHandle, szSummary, sizeof(szSummary), &nStatus)

 

See Also

GxPioGetDriverSummary, Gx5733Initialize, GxPioGetErrorString