GxAoGetBoardSummary

Purpose

Returns the board name, description, S/N, firmware version and revision, and calibration time.

Syntax

GxPsGetBoardSummary (nHandle, pszSummary, nSummaryMaxLen, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX16xx board.
pszSummary
PSTR
Buffer to contain the returned board info (null terminated) string.
nSummaryMaxLen
SHORT
Size of the buffer to contain the error string.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The GXAO board summary string provides the following data from the on-board nonvolatile electrically erasable programmable read-only memory (EEPROM) in the order shown:

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

 

“GX1648 48 Channels Analog Outputs, EEPROM-Version:1, Board-Revision:A, FPGA-Version:0x0A03, S/N 1648002, Calibration-time:Wed Aug 14 17:30:04 2002”

 

Example

The following example returns the board summary:

 

SHORT nHandle, nStatus;

CHAR szSummary[256];

 

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

 

See Also

GxAoGetDriverSummary, GxAoInitialize, GxAoGetErrorString