nlThreadCreate

creates a child thread

C Specification

NLthreadID nlThreadCreate(NLThreadFunc func, void *data, NLboolean joinable)

Parameters

func

[in]The function the new thread will run.

data

[in]Pointer to the data that will be passed to the function. Can be NULL if there is no data.

joinable

[in]Will the new thread be joinable?

Description

nlThreadCreate creates a child thread that calls func with data. If you want to be able to join the thread with nlThreadJoin then set joinable to NL_TRUE.

Return values

If joinable is NL_TRUE and no error occurs, then nlThreadCreate returns a valid NLthreadID for nlThreadJoin, otherwise it returns NL_INVALID cast to NLthreadID.

If joinable is NL_FALSE and no error occurs, then nlThreadCreate returns NULL, otherwise it returns NL_INVALID cast to NLthreadID.

Error codes

NL_SYSTEM_ERROR : A system error has ocurred. The system error can be retrieved by calling nlGetSystemError.
NL_OUT_OF_MEMORY : Not enough memory.

See also

nlThreadJoin,
nlThreadYield


Back to the HawkNL index page


Go directly to the main HawkNL page at Hawk Software

© 2000-2002 Phil Frisbie.

Valid XHTML 1.0!