Rate This Document
Findability
Accuracy
Completeness
Readability

HTL_thread_cancel

Sends a cancellation instruction to a thread.

Interface Definition

int HTL_thread_cancel(HTL_thread_t thread);

Description

HTL_thread_cancel() sends a cancellation request to a thread. This thread may terminate before its thread function is completed.

Parameters

Parameter

Type

Description

Input/Output

thread

HTL_thread_t

Address of the handle to the thread.

Input

Return Value

  • HTL_THREAD_SUCCESS: success.
  • Other values: failure. For details, see the error code descriptions.

Example

1
2
3
4
status = HTL_thread_cancel(thread);
if (status != HTL_THREAD_SUCCESS) {
    ......
}