Looks up an AG or CG board by its driver ID information and returns its name.
DWORD oamBoardLookupByDriverIDs ( CTAHD ctahd, const char *szDriverName, const char *szDriverBoardID, char *szName, DWORD dwNameSize )
|
Argument |
Description |
|
ctahd |
[in] Context handle. |
|
szDriverName |
[in] Pointer to a driver name for which to search. |
|
szDriverBoardID |
[in] Pointer to a driver board ID for which to search. |
|
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, szDriverName, or szDriverBoardID 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 driver board ID is used by a given board driver to refer to a board. Typically (but not necessarily) the ID is an integer. The ID for a board is unique among all IDs associated with the driver. However, the ID is not necessarily unique among all boards in a host: two boards with different drivers can (by chance) have the same driver board ID number. Boards must be started when you invoke this function.
For more information, see Retrieving board information.
oamBoardLookupByBusSlot, oamBoardLookupByMACAddress, oamBoardLookupByNumber, oamBoardLookupByProduct, oamBoardLookupByShelfSlot