SAM function SAM-Execution-cancel()

From SoOS

Jump to: navigation, search


[edit] Name

SAM_Execution_cancel - Cancel the execution of a worker thread

[edit] Synopsis

#include <sam.h>
void SAM_Execution_cancel(SAM_t sam, SAM_Workerid_t wid);

[edit] Description

The SAM_Execution_cancel() function cancels the execution of the worker thread wid. On its return, the worker thread is already cancelled. It shall only be called from the main execution thread.

[edit] Return value


[edit] Errors

None, assumes correct input parameters.

[edit] Examples


[edit] See also

SAM_Execution_create(), SAM_Execution_join(), SAM_Execution_start(), SAM_Execution_finish(), SAM_Execution_restart(), <sam.h>.