nlCondWait

wait for a condition to be signaled

C Specification

NLboolean nlCondWait(NLcond *cond, NLint timeout)

Parameters

cond

[in]The condition variable to wait for.

[in]Specifies the timeout in milliseconds, or negative (-1) for full blocking.

Description

nlCondWait causes the thread to wait for the condition to be signaled or time out.

Return values

NL_TRUE if no error occurs and the condition did not time out.

Otherwise NL_FALSE, and the specific error code can be retrieved by calling nlGetError

Error codes

NL_NULL_POINTER : A NULL pointer was passed to this function.
NL_SYSTEM_ERROR : A system error has ocurred. The system error can be retrieved by calling nlGetSystemError.
NL_TIMED_OUT : The wait timed out before being signaled.

See also

nlCondInit,
nlCondDestroy,
nlCondBroadcast,
nlCondSignal

Back to the HawkNL index page

Go directly to the main HawkNL page at Hawk Software

© 2000-2002 Phil Frisbie.