WaitDispatchingMessages function
[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The WaitDispatchingMessages function waits for an object to be signaled, while dispatching window messages.
Syntax
DWORD WINAPI WaitDispatchingMessages(
HANDLE hObject,
DWORD dwWait,
HWND hwnd = NULL,
UINT uMsg = 0,
HANDLE hEvent = NULL
);
Parameters
-
hObject
-
Handle of the object to wait for.
-
dwWait
-
Time-out interval, in milliseconds.
-
hwnd
-
Optional handle to a window.
-
uMsg
-
Optional window message, specifying a message to dispatch.
-
hEvent
-
Optional handle to an event to wait for.
Return value
Returns the value from the WaitForMultipleObjects function.
Remarks
If an object owns a window, it should dispatch window messages while waiting. This function enables the object to wait for an event, semaphore, or other mutual exclusion object while dispatching messages.
Requirements
| Requirement | Value |
|---|---|
| Header |
|
| Library |
|
See also