IDispatchable.Poll

Method

Visual Basic

Function Poll () As Boolean

C#

bool Poll ();

Purpose

Dispatch an event, if possible.

Remarks

If an event is ready to dispatch, then this call dispatches it, and then returns. If no events are waiting, then this call returns immediately.

When the call dispatches an event, it returns true. When the call does not dispatch an event, it returns false.

This call is equivalent to timedDispatch(TimeoutValue.NoWait).

Both Queue and QueueGroup implement this method.

See Also

IDispatchable

Queue.Poll

QueueGroup.Poll