Creates a new managed object for a board.
DWORD oamCreateBoard ( CTAHD ctahd, const char *szProduct, char *szName, DWORD dwNameSize )
|
Argument |
Description |
|
ctahd |
[in] Context handle. |
|
szProduct |
[in] Pointer to a product type. |
|
szName |
[out] Pointer to buffer to receive object name. |
|
dwNameSize |
[in] Size of szName (maximum number of bytes to return including the 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_FILE_WRITE_ERROR |
Error writing to database. |
|
OAMERR_NOT_ENOUGH_MEMORY |
Memory allocation error or the specified buffer size is too small. |
|
OAMERR_NOT_FOUND |
szProduct not found (is invalid). |
|
OAMERR_SERVER_NOT_RUNNING |
Supervisor is shut down. |
oamCreateBoard creates a new managed object for a board of product type szProduct. Each board plug-in supports a different set of product types. The products supported by the set of plug-ins installed on a resource host can be determined by examining the Supervisor keyword Products[x].
If the function succeeds, a new managed object is created. A record containing default keyword settings is created for the object in the NMS OAM database. A default name and board number are generated for the board.
The board name is passed back in the function call. The name is added to the list of board names in the Supervisor keyword Boards[x].
Retrieve the board number using any oamBoardLookupByXXX function, as described in Retrieving board information.
To change the board name and board number, modify the Name or Number keywords for the board managed object. Refer to Accessing configuration data.
For more information about creating managed objects, see Managing board information.