Looks up a board by its board number and returns its name.
DWORD oamBoardLookupByNumber ( CTAHD ctahd, DWORD dwNumber, char *szName, DWORD dwNameSize )
|
Argument |
Description |
|
ctahd |
[in] Context handle. |
|
dwNumber |
[in] Number of board 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 value |
Description |
|
SUCCESS |
|
|
CTAERR_BAD_ARGUMENT |
szName 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. |
A board number is a number used to identify a board in a resource host. The number is unique among all boards in a host. Many Natural Access services use the board number to identify a board.
A default board number is assigned to a board when a managed object for the board is created using oamCreateBoard. To change the board number, set the Number keyword for the board managed object.
For more information, see Retrieving board information.
oamBoardLookupByBusSlot, oamBoardLookupByDriverIDs, oamBoardLookupByMACAddress, oamBoardLookupByProduct