UnregisterWait

The UnregisterWait function cancels a registered wait operation issued by the RegisterWaitForSingleObject function.

To use a completion event, call the UnregisterWaitEx function.

BOOL UnregisterWait(
  HANDLE WaitHandle      // wait handle
);

Parameters

WaitHandle

[in] Wait handle. This handle is returned by the RegisterWaitForSingleObject function.

Return Values

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

UnregisterWait does not wait for all callback functions associated with the timer to complete.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Winbase.h; include Windows.h.
  Library: Use Kernel32.lib.

See Also

Synchronization Overview, Synchronization Functions, RegisterWaitForSingleObject, UnregisterWaitEx, Thread Pooling