nlThreadJoin

joins a child thread

C Specification

NLboolean nlThreadJoin(NLthreadID threadid, void **status)

Parameters

threadid

[in]The NLthreadID of the thread to join.

status

[in/out]Pointer to the variable that will recieve the return code of the thread, cast to a void *. Can be NULL if you do not want the return value.

Description

nlThreadJoin blocks until the thread specified by threadid exits. The thread must have been created with the joinable option set to NL_TRUE.

Return values

NL_TRUE if no error occurs, otherwise NL_FALSE, and the specific error code can be retrieved by calling nlGetError

Error codes

NL_SYSTEM_ERROR : A system error has ocurred. The system error can be retrieved by calling nlGetSystemError.

See also

nlThreadCreate,
nlThreadYield

Back to the HawkNL index page

Go directly to the main HawkNL page at Hawk Software

© 2000-2002 Phil Frisbie.