Returns the driver ID information for an AG or CG board with the given name.
DWORD oamBoardGetDriverIDs ( CTAHD ctahd, const char *szName, char *szDriverName, DWORD dwDriverNameSize, char *szDriverBoardID, DWORD dwDriverBoardIDSize )
|
Argument |
Description |
|
ctahd |
[in] Context handle. |
|
szName |
[in] Pointer to a name of board to look up. |
|
szDriverName |
[out] Pointer to buffer to receive driver name. |
|
dwDriverNameSize |
[in] Size of szDriverName (maximum number of bytes to return, including final null character). |
|
szDriverBoardID |
[out] Pointer to buffer to receive driver ID. |
|
dwDriverBoardIDSize |
[in] Size of dwDriverBoardID (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 board driver uses a driver ID 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 resource host: two boards with different drivers can (by chance) have the same driver board ID number. Boards must be started when you invoke oamBoardGetDriverIDs.
For more information, see Retrieving board information.
oamBoardGetBusSlot, oamBoardGetMACAddress, oamBoardGetNumber, oamBoardGetProduct, oamBoardGetSerialNumber, oamBoardGetShelfSlot, oamBoardGetStatus