IEventQueue::DispatchEvent

boolIEventQueue::DispatchEvent(IEventRouter*pIEventRouter)

Remove next event from the queue and send it to an event router

Defined in: EventQueue.h

Return Value

TRUE if an event was dispatched; otherwise FALSE.

Parameters

pIEventRouter

Pointer to event router to receive event.

Comments

The queue determines the next event to be dispatched and pulls it from the queue. It then sends it to the event router using the  IEventRouter::RouteEvent method. The next event in the queue is usually determined by a combination of chronological order and priority. This function removes the event from the queue.