CAMEvent.Wait method

[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 Wait method blocks until the event is signaled, or until a time-out occurs.

Syntax

BOOL Wait(
   DWORD dwTimeout = INFINITE
);

Parameters

dwTimeout

Optional time-out value, represented in milliseconds.

Return value

Returns TRUE if the event is signaled. Otherwise, returns FALSE.

Remarks

For auto-reset events, the event is reset to a nonsignaled state when this method returns.

Requirements

See also

CAMEvent Class