Returns the board number for the board with the given name.
DWORD oamBoardGetNumber ( CTAHD ctahd, const char *szName, DWORD *pdwNumber )
|
Argument |
Description |
|
ctahd |
[in] Context handle. |
|
szName |
[in] Pointer to the name of board to look up. |
|
pdwNumber |
[out] Set to the board number. |
|
Return values |
Description |
|
SUCCESS |
|
|
CTAERR_BAD_ARGUMENT |
szName or pdwNumber is NULL or 0. |
|
CTAERR_SVR_COMM |
Natural Access Server is not running. |
|
OAMERR_NOT_FOUND |
Board not found. |
|
OAMERR_SERVER_NOT_RUNNING |
Supervisor is shut down. |
A board number identifies 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. Change the board number by setting the Number keyword for the board's managed object.
For more information, see Retrieving board information.
oamBoardGetBusSlot, oamBoardGetDriverIDs, oamBoardGetMACAddress, oamBoardGetProduct, oamBoardGetSerialNumber, oamBoardGetShelfSlot, oamBoardGetStatus