Edit

Share via

COWAIT_FLAGS enumeration (combaseapi.h)

  • Article

Specifies the behavior of the CoWaitForMultipleHandles function.

Syntax

typedef enum tagCOWAIT_FLAGS {
  COWAIT_DEFAULT = 0,
  COWAIT_WAITALL = 1,
  COWAIT_ALERTABLE = 2,
  COWAIT_INPUTAVAILABLE = 4,
  COWAIT_DISPATCH_CALLS = 8,
  COWAIT_DISPATCH_WINDOW_MESSAGES = 0x10
} COWAIT_FLAGS;

Constants

 
COWAIT_DEFAULT
Value: 0
Dispatch calls needed for marshaling without dispatching arbitrary calls.
COWAIT_WAITALL
Value: 1
If set, the call to CoWaitForMultipleHandles will return S_OK only when all handles associated with the synchronization object have been signaled and an input event has been received, all at the same time. In this case, the behavior of CoWaitForMultipleHandles corresponds to the behavior of the MsgWaitForMultipleObjectsEx function with the dwFlags parameter set to MWMO_WAITALL. If COWAIT_WAITALL is not set, the call to CoWaitForMultipleHandles will return S_OK as soon as any handle associated with the synchronization object has been signaled, regardless of whether an input event is received.
COWAIT_ALERTABLE
Value: 2
If set, the call to CoWaitForMultipleHandles will return S_OK if an asynchronous procedure call (APC) has been queued to the calling thread with a call to the QueueUserAPC function, even if no handle has been signaled.
COWAIT_INPUTAVAILABLE
Value: 4
If set, the call to CoWaitForMultipleHandles will return S_OK if input exists for the queue, even if the input has been seen (but not removed) using a call to another function, such as PeekMessage.
COWAIT_DISPATCH_CALLS
Value: 8
Dispatch calls from CoWaitForMultipleHandles in an ASTA. Default is no call dispatch. This value has no meaning in other apartment types and is ignored.
COWAIT_DISPATCH_WINDOW_MESSAGES
Value: 0x10
Enables dispatch of window messages from CoWaitForMultipleHandles in an ASTA or STA. Default in ASTA is no window messages dispatched, default in STA is only a small set of special-cased messages dispatched. The value has no meaning in MTA and is ignored.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header combaseapi.h (include Objbase.h)

See also

CoWaitForMultipleHandles

ISynchronize::Wait

ISynchronizeContainer::WaitMultiple