ntdll: Clarify the documentation for HandleTable.

This commit is contained in:
Jeff Latimer 2006-11-06 22:49:51 +11:00 committed by Alexandre Julliard
parent 4f2819f2e1
commit 54421bf806
1 changed files with 10 additions and 0 deletions

View File

@ -186,6 +186,16 @@ static NTSTATUS RtlpAllocateSomeHandles(RTL_HANDLE_TABLE * HandleTable)
* Success: Pointer to allocated handle.
* Failure: NULL.
*
* NOTES
* A valid handle must have the bit set as indicated in the code below
* otherwise subsquent RtlIsValidHandle() calls will fail.
*
* static inline void RtlpMakeHandleAllocated(RTL_HANDLE * Handle)
* {
* ULONG_PTR *AllocatedBit = (ULONG_PTR *)(&Handle->Next);
* *AllocatedBit = *AllocatedBit | 1;
* }
*
* SEE
* RtlFreeHandle().
*/