Skip to content

Latest commit

 

History

History
108 lines (87 loc) · 3.03 KB

nf-objidlbase-isynchronize-wait.md

File metadata and controls

108 lines (87 loc) · 3.03 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:objidlbase.ISynchronize.Wait
ISynchronize::Wait (objidlbase.h)
The ISynchronize::Wait (objidlbase.h) method waits for the synchronization object to be signaled or for a specified timeout period to elapse.
ISynchronize interface [COM]
Wait method
ISynchronize.Wait
ISynchronize::Wait
Wait
Wait method [COM]
Wait method [COM]
ISynchronize interface
_com_isynchronize_wait
com.isynchronize_wait
objidlbase/ISynchronize::Wait
com\isynchronize_wait.htm
com
1abed0be-b4e3-41f4-af6c-e327ce934b59
08/15/2022
ISynchronize interface [COM],Wait method, ISynchronize.Wait, ISynchronize::Wait, Wait, Wait method [COM], Wait method [COM],ISynchronize interface, _com_isynchronize_wait, com.isynchronize_wait, objidlbase/ISynchronize::Wait
objidlbase.h
ObjIdl.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
ObjIdl.idl
Windows
19H1
ISynchronize::Wait
objidlbase/ISynchronize::Wait
c++
APIRef
kbSyntax
COM
objidlbase.h
ISynchronize.Wait

ISynchronize::Wait

-description

Waits for the synchronization object to be signaled or for a specified timeout period to elapse, whichever comes first.

-parameters

-param dwFlags [in]

The wait options. Possible values are taken from the COWAIT_FLAGS enumeration.

-param dwMilliseconds [in]

The time this call will wait before returning, in milliseconds. If this parameter is INFINITE, the caller will wait until the synchronization object is signaled, no matter how long it takes. If this parameter is 0, the method returns immediately.

-returns

This method can return the standard return values E_INVALIDARG, E_OUTOFMEMORY, and E_FAIL, as well as the following values.

Return code Description
S_OK
The synchronization object was signaled.
RPC_E_CALLPENDING
The time-out period elapsed before the synchronization object was signaled.

-remarks

If the caller is waiting in a single-thread apartment, Wait enters the COM modal loop. If the caller is waiting in a multithread apartment, the caller is blocked until Wait returns.

-see-also

CoWaitForMultipleHandles

ISynchronize