| Home
| Previous
| Next
| Up

EVT_peekNext

Peeks at the next pending event in the event queue.

Declaration

ibool EVTAPI EVT_peekNext(
event_t *evt,
ulong mask)

Prototype In

event.h

Parameters

evt | Pointer to structure to return the event info in
mask | Mask specifying the types of events that should be removed

Return Value

True if an event is pending, false if not.

Description

Peeks at the next pending event of the specified type in the event queue. The mask parameter is used to specify the type of events to be peeked at, and can be any logical combination of any of the flags defined by the EVT_eventType enumeration.

In contrast to EVT_getNext, the event is not removed from the event queue. You may combine the masks for different event types with a simple logical OR.

See Also

EVT_flush, EVT_getNext, EVT_halt

Copyright © 2002 SciTech Software, Inc. Visit our web site at http://www.scitechsoft.com