RtlRegisterWait(3w)

RtlRegisterWait3w

Usage

NTSTATUS RtlRegisterWait
(
PHANDLE NewWaitObject,
HANDLE Object,
RTL_WAITORTIMERCALLBACKFUNC Callback,
PVOID Context,
ULONG Milliseconds,
ULONG Flags
)

Overview

Registers a wait for a handle to become signaled.

Params

NewWaitObject [In] Handle to the new wait object. Use RtlDeregisterWait(3w) to free it.

Object [In] Object to wait to become signaled.

Callback [In] Callback function to execute when the wait times out or the handle is signaled.

Context [In] Context to pass to the callback function when it is executed.

Milliseconds [In] Number of milliseconds to wait before timing out.

Flags [In] Flags. See notes.

Returns

Success: STATUS_SUCCESS.

Failure: Any NTSTATUS code.

Notes

Flags can be one or more of the following:
WT_EXECUTEDEFAULT - Executes the work item in a non-I/O worker thread.
WT_EXECUTEINIOTHREAD - Executes the work item in an I/O worker thread.
WT_EXECUTEINPERSISTENTTHREAD - Executes the work item in a thread that is persistent.
WT_EXECUTELONGFUNCTION - Hints that the execution can take a long time.
WT_TRANSFER_IMPERSONATION - Executes the function with the current access token.

Implementation

Declared in "winternl.h".

Implemented in "dlls/ntdll/threadpool.c".

Debug channel "threadpool".

Releases

3 releases since Debian 5.0 (Lenny); the text changed 2 times.

  1. 5.0
  2. 6.0
  3. 7

From libwine-dev 1.4.1-4 in Debian 7 (Wheezy). Parsed by carta from the page's man source.