oamBoardGetStatus

Queries the board status.

DWORD oamBoardGetStatus ( CTAHD ctahd, const char *szName, INT32 dataDescriptor, INT32 *data )

Argument

Description

ctahd

[in] Context handle.

szName

[in] Pointer to the name of board to look up.

dataDescriptor

[in] Specifies the query data.

The following table lists the valid values for dataDescriptor and the boards that each value supports:

Value	Description	Supported CG boards
0	CPU utilization during the last second of operation, as a percentage of available CPU.	All
1	Average CPU utilization over the last sixteen seconds of operation, as a percentage of available CPU.	All
2	Heap usage, in bytes.	All
3	Available memory, in bytes.	All
4	Main temperature sensor, in tenths of a degree Celsius.	All
5	CPU temperature sensor, in tenths of a degree Celsius.	CG 6565/c/e
6	DSP temperature sensor, in tenths of a degree Celsius.	CG 6565/c/e
7	IO temperature sensor, in tenths of a degree Celsius.	CG 6565/c/e
8	Fan tachometer, in RPM.	CG 6565/e

data

[out] Pointer to the query result. For status types, see the dataDescriptor argument.

Return value	Description
SUCCESS
CTAERR_BAD_ARGUMENT	szName, pdwShelf, or pdwSlot is NULL or 0.
CTAERR_SVR_COMM	Natural Access Server is not running.
OAMERR_NOT_FOUND	Board not found.
OAMERR_NOT_SUPPORTED_WARNING	Board is not a CG board, or the requested data is not available on the board.
OAMERR_SERVER_NOT_RUNNING	Supervisor is shut down.

The application must specify the type of query data. Available data depends on the board type, as described in the description of dataDescriptor.