Tests one or more CG boards.
DWORD oamTestBoard ( CTAHD ctahd, const char *szName, DWORD dwOptions )
|
Argument |
Description |
|
ctahd |
[in] Context handle. |
|
szName |
[in] Pointer to the name of board to test. Set to NULL to test all boards in parallel. |
|
dwOptions |
[in] Test level bit mask. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_SVR_COMM |
Natural Access Server is not running. |
|
OAMERR_ACCESS_DENIED |
Function is not supported by this plug-in. |
|
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_TESTBOARD_DONE |
Function completed successfully. The event value field contains the result of the board testing attempt: OAM_REASON_FINISHED OAM_REASON_FAILED |
oamTestBoard tests the specified CG boards, 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. CG boards must be stopped when you invoke oamTestBoard.