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

.SH NAME
\fBRtlAllocateHandle\fR (NTDLL.@)
.SH SYNOPSIS
RTL_HANDLE * RtlAllocateHandle
 (
  RTL_HANDLE_TABLE* \fIHandleTable\fR,
  ULONG*            \fIHandleIndex\fR
 )

.SH DESCRIPTION
.PP
Allocates a handle from the handle table. 

.SH PARAMS
\fIHandleTable\fR \fB[In/Out]\fR  The handle table.
.PP
\fIHandleIndex\fR \fB[Out]\fR  Index of the handle returned. Optional.
.PP

.SH RETURNS
.PP
\fBSuccess:\fR Pointer to allocated handle. 
.PP
\fBFailure:\fR \fBNULL\fR. 

.SH NOTES
.PP
A valid handle must have the bit set as indicated in the code below otherwise subsequent \fBRtlIsValidHandle(3w)\fR calls will fail. 
.PP
static inline void RtlpMakeHandleAllocated(\fBRTL_HANDLE\fR * Handle) { \fBULONG_PTR\fR *AllocatedBit = (\fBULONG_PTR\fR *)(&Handle\fI->Next\fR); *AllocatedBit = *AllocatedBit | 1; }. 

.SH SEE
.PP
RtlFreeHandle(). 

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