Starts one or more boards.
DWORD oamStartBoard ( CTAHD ctahd, const char *szName )
|
Argument |
Description |
|
ctahd |
[in] Context handle. |
|
szName |
[in] Pointer to the name of board to start. Set to NULL to start all boards in parallel. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_SVR_COMM |
Natural Access Server is not running. |
|
OAMERR_CANT_CREATE_THREAD |
Cannot create thread to do asynchronous operations. |
|
OAMERR_NOT_FOUND |
Board szName not found. |
|
OAMERR_SERVER_NOT_RUNNING |
Supervisor is shut down. |
|
Event |
Description |
|
OAMEVN_STARTBOARD_DONE |
Function completed successfully. The event value field contains the result of the board starting attempt: OAM_REASON_FINISHED OAM_REASON_FAILED |
oamStartBoard starts the specified board, or all boards in parallel. Because this function can incur delay, it is an asynchronous call that returns immediately and is followed by an alert notification on completion.
For more information, see Starting, stopping, and testing boards.