Given a product type, returns the board name of the first board of that product type listed in the NMS OAM database.
DWORD oamBoardLookupByProduct ( CTAHD ctahd, const char *szProduct char *szName, DWORD dwNameSize )
|
Argument |
Description |
|
ctahd |
[in] Context handle. |
|
szProduct |
[in] Pointer to a product type 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 or szProduct 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. |
The specified product type must be one of the product types listed in the Supervisor keyword Products[x]. Only the board name of the first board of the specified product type is returned. For more information, see Retrieving board information.
oamBoardLookupByBusSlot, oamBoardLookupByDriverIDs, oamBoardLookupByMACAddress, oamBoardLookupByNumber, oamBoardLookupByShelfSlot