Returns the board summary.
Gx5731GetBoardSummary (nHandle, szSummary, nSumMaxLen, pnStatus)
Name |
Type |
Description |
nHandle |
SHORT |
Handle to a GX5731 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. |
The GX5731 summary string provides the following data:
Instrument name (e.g., GX5731)
FPGA version of main board (e.g. 0xA003)
Each installed Module’s FPGA version.
For example, the returned string could look like the following:
GX5731, FPGA Version:0xA000, Module: GX5701 FPGA Version:0x000A
The following example returns the board summary:
SHORT nHandle, nStatus;
CHAR szSummary [256];
Gx5731GetBoardSummary(nHandle, szSummary, sizeof(szSummary), &nStatus)
GxPIOGetDriverSummary, Gx5731Initialize, GxPioGetErrorString