Skip to content

Latest commit

 

History

History
102 lines (77 loc) · 3.42 KB

nf-winbase-unregisterwait.md

File metadata and controls

102 lines (77 loc) · 3.42 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:winbase.UnregisterWait
UnregisterWait function (winbase.h)
Cancels a registered wait operation issued by the RegisterWaitForSingleObject function. (UnregisterWait)
UnregisterWait
UnregisterWait function
_win32_unregisterwait
base.unregisterwait
winbase/UnregisterWait
base\unregisterwait.htm
backup
9ae8879f-0dbd-4d04-ae6e-094324f82acf
12/05/2018
UnregisterWait, UnregisterWait function, _win32_unregisterwait, base.unregisterwait, winbase/UnregisterWait
winbase.h
Windows.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Kernel32.lib
Kernel32.dll
Windows
19H1
UnregisterWait
winbase/UnregisterWait
c++
APIRef
kbSyntax
DllExport
Kernel32.dll
API-MS-Win-Core-Kernel32-Legacy-l1-1-0.dll
kernel32legacy.dll
API-MS-Win-Core-Kernel32-Legacy-l1-1-1.dll
API-MS-Win-Core-Kernel32-Legacy-l1-1-2.dll
API-MS-Win-DownLevel-Kernel32-l2-1-0.dll
API-MS-Win-Core-Kernel32-Legacy-L1-1-3.dll
API-MS-Win-Core-Kernel32-Legacy-L1-1-4.dll
API-MS-Win-Core-Kernel32-Legacy-L1-1-5.dll
UnregisterWait

UnregisterWait function

-description

Cancels a registered wait operation issued by the RegisterWaitForSingleObject function.

To use a completion event, call the UnregisterWaitEx function.

-parameters

-param WaitHandle [in]

The wait handle. This handle is returned by the RegisterWaitForSingleObject function.

-returns

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

-remarks

If any callback functions associated with the timer have not completed when UnregisterWait is called, UnregisterWait unregisters the wait on the callback functions and fails with the ERROR_IO_PENDING error code. The error code does not indicate that the function has failed, and the function does not need to be called again. If your code requires an error code to set only when the unregister operation has failed, call UnregisterWaitEx instead.

To compile an application that uses this function, define _WIN32_WINNT as 0x0500 or later. For more information, see Using the Windows Headers.

-see-also

RegisterWaitForSingleObject

Synchronization Functions

Thread Pooling

UnregisterWaitEx