Jeff Latimer : ntdll: Clarify the documentation for HandleTable.

[Alexandre Julliard]

Module: wine
Branch: master
Commit: 54421bf806491999e3f3225b1b19f914ab9257c6
URL:    http://source.winehq.org/git/wine.git/?a=commit;h=54421bf806491999e3f3225b1b...

Author: Jeff Latimer 
Date:   Mon Nov  6 22:49:51 2006 +1100

ntdll: Clarify the documentation for HandleTable.

---

dlls/ntdll/handletable.c |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

diff --git a/dlls/ntdll/handletable.c b/dlls/ntdll/handletable.c
index 51eb6ce..5105716 100644
--- a/dlls/ntdll/handletable.c
+++ b/dlls/ntdll/handletable.c
@@ -186,6 +186,16 @@ static NTSTATUS RtlpAllocateSomeHandles(
  *  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().
  */