# oamStopBoard

Stops one or more boards.

#### Prototype

DWORD oamStopBoard ( CTAHD ctahd, const char *szName )

Argument | Description
ctahd | [in] Context handle.
szName | [in] Name of board to stop. Set to NULL to stop all boards.

#### Return values

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.

#### Events

Event | Description
OAMEVN_STOPBOARD_DONE | Function completed successfully. The event value field contains the result of the attempt to stop the board: OAM_REASON_FINISHED Board stopped successfully. OAM_REASON_FAILED Board stop attempt failed. Further information is available in the OAM_MSG message buffer.
OAMEVN_STOPBOARD_REQ | Request was made to stop a board. The board will be stopped in 150 ms.

Note: In addition to these return values, this function can return board type-specific values. For more information about possible board errors, see the board-specific documentation.

#### Details

oamStopBoard stops 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.

Note: oamStopBoard stops boards regardless of any tasks they are currently performing. To avoid problems, make sure that a board is idle before stopping it.

For more information, see Starting, stopping, and testing boards.

#### See also

oamStartBoard, oamTestBoard