.\" -*- nroff -*-
.\" Generated file - DO NOT EDIT!
.TH RtlRegisterWait 3w "Oct 2012" "Wine API" "Wine API"

.SH NAME
\fBRtlRegisterWait\fR (NTDLL.@)
.SH SYNOPSIS
NTSTATUS RtlRegisterWait
 (
  PHANDLE                     \fINewWaitObject\fR,
  HANDLE                      \fIObject\fR,
  RTL_WAITORTIMERCALLBACKFUNC \fICallback\fR,
  PVOID                       \fIContext\fR,
  ULONG                       \fIMilliseconds\fR,
  ULONG                       \fIFlags\fR
 )

.SH DESCRIPTION
.PP
Registers a wait for a handle to become signaled. 

.SH PARAMS
\fINewWaitObject\fR \fB[In]\fR  Handle to the new wait object. Use \fBRtlDeregisterWait(3w)\fR to free it.
.PP
\fIObject\fR \fB[In]\fR  \fIObject\fR to wait to become signaled.
.PP
\fICallback\fR \fB[In]\fR  \fICallback\fR function to execute when the wait times out or the handle is signaled.
.PP
\fIContext\fR \fB[In]\fR  \fIContext\fR to pass to the callback function when it is executed.
.PP
\fIMilliseconds\fR \fB[In]\fR  Number of milliseconds to wait before timing out.
.PP
\fIFlags\fR \fB[In]\fR  \fIFlags\fR. See notes.
.PP

.SH RETURNS
.PP
\fBSuccess:\fR \fBSTATUS_SUCCESS\fR. 
.PP
\fBFailure:\fR Any \fBNTSTATUS\fR code. 

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

.SH IMPLEMENTATION
.PP
Declared in \fB"winternl.h"\fR. 
.PP
Implemented in \fB"dlls/ntdll/threadpool.c"\fR. 
.PP
Debug channel \fB"threadpool"\fR.