oamBoardLookupBySerialNumber

Looks up a board by its serial number and returns its name.

Prototype

DWORD oamBoardLookupBySerialNumber ( CTAHD ctahd, const char *szSerialNumber, char *szName, DWORD dwNameSize )

Argument

Description

ctahd

[in] Context handle.

szSerialNumber

[in] Pointer to a serial number to look up.

szName

[out] Pointer to buffer to receive name of board.

dwNameSize

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


Return values

Return value

Description

SUCCESS

 

CTAERR_BAD_ARGUMENT

szName or szSerialNumber 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

Supervisor is shut down.


Details

Boards must be booted when you invoke oamBoardLookupBySerialNumber. For more information, see Retrieving board information.

See also

oamBoardLookupByBusSlot, oamBoardLookupByDriverIDs, oamBoardLookupByMACAddress, oamBoardLookupByNumber, oamBoardLookupByProduct, oamBoardLookupByShelfSlot