oamBoardGetProduct

Returns the product type for the board with the given name.

Prototype

DWORD oamBoardGetProduct ( CTAHD ctahd, const char *szName, char *szProduct, DWORD dwProductSize )

Argument

Description

ctahd

[in] Context handle.

szName

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

szProduct

[out] Pointer to buffer to receive board's product type.

dwProductSize

[in] Size of szProduct (maximum number of bytes to return, including final null character).


Return values

Return value

Description

SUCCESS

 

CTAERR_BAD_ARGUMENT

szName or szProduct is NULL or 0.

CTAERR_SVR_COMM

Natural Access Server is not running.

OAMERR_NOT_ENOUGH_MEMORY

Specified buffer size is too small.

OAMERR_NOT_FOUND

Board not found.

OAMERR_SERVER_NOT_RUNNING

NMS OAM supervisor is shut down.


Details

The product type returned by oamBoardGetProduct is one of the product types listed in the Supervisor keyword Products[x].

For more information, see Retrieving board information.

See also

oamBoardGetBusSlot, oamBoardGetDriverIDs, oamBoardGetMACAddress, oamBoardGetNumber, oamBoardGetSerialNumber, oamBoardGetShelfSlot, oamBoardGetStatus