GrGetNextEventTimeout()

Name

GrGetNextEventTimeout() -- Get an event from the queue

Synopsis

void GrGetNextEventTimeout ( GR_EVENT * ep , GR_TIMEOUT timeout );

Description

This function retrieves the next nano-X event from the event queue and returns the event in the caller supplied GR_EVENT structure. If the event queue is empty, the function will block until either another event occurs or the specified timeout period expires.

Note

If the timeout period expires, a GR_EVENT_TYPE_TIMEOUT event is placed in the GR_EVENT structure pointed to by ep.

Parameters

TypeNameDescription
GR_EVENT*epPointer to the caller supplied structure that will receive the next event from the event queue.
GR_TIMEOUTtimeoutThe timeout period in milliseconds. If 0 is specified the function will block forever, similar to the function GrGetNextEvent().

See Also

GrSelectEvents(), GrGetNextEvent(), GrCheckNextEvent(), GrPeekEvent(), GrMainLoop().