Deletes the managed object for a board or all board managed objects.
DWORD oamDeleteBoard ( CTAHD ctahd, const char *szName )
|
Argument |
Description |
|
ctahd |
[in] Context handle. |
|
szName |
[in] Pointer to the name of board to delete. Specify NULL to delete all board managed objects. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_SVR_COMM |
Natural Access Server is not running. |
|
OAMERR_ACCESS_DENIED |
Managed object is opened by another application. |
|
OAMERR_NOT_ENOUGH_MEMORY |
Memory allocation error or the specified buffer size is too small. |
|
OAMERR_SERVER_NOT_RUNNING |
Supervisor is shut down. |
Note: Other board-specific errors can also be received. For information about possible board errors, see the board-specific documentation.
|
Event |
Description |
|
OAMEVN_DELETED |
Board object was deleted. |
|
OAMEVN_STOPBOARD_DONE |
Function completed successfully. The event value field contains the result of the board starting attempt: OAM_REASON_FINISHED OAM_REASON_FAILED |
oamDeleteBoard deletes the managed object for a specified board or for all boards. The specified boards must exist as managed objects. To obtain the names of all managed boards, examine the Supervisor keyword Boards[x].
oamDeleteBoard is an asynchronous function. If the board was running when oamDeleteBoard was invoked, it is stopped before the managed object is deleted.
An application cannot delete a board managed object if it is currently open by another application.
For more information about deleting managed objects, see Managing board information.