1234567891011121314151617181920212223242526 |
- [Main]
- Name=HeapPtrToHandle
- Type=Function
- Subtype=ROM Call
- Header Files=alloc.h
- Definition=HANDLE HeapPtrToHandle (void *Ptr);
- See Also=alloc.h/PtrToHandle
- [ROM Call]
- Index=$23A
- [Description]
- Determines the handle associated with a block.
- [Explanation]
- HeapPtrToHandle returns the handle associated to the block whose beginning is
- pointed to by <I>Ptr</I> (or <A HREF="$$LINK(alloc.h/H_NULL)">H_NULL</A> if <I>Ptr</I>
- does not point to the beginning of a block).
- <BR>
- This routine works by searching the entire table of handles for the given pointer.
- It will return meaningful results only if the block of memory was not moved (e.g. by heap
- compression) since the pointer was originally obtained.
- <BR>
- <B>Note:</B> <A HREF="$$LINK(alloc.h/PtrToHandle)">PtrToHandle</A>, implemented in the
- TIGCC library, returns the handle associated to the block referenced by the pointer,
- even if the pointer does not point to the beginning of the block.
|