Changeset 36372 in vbox for trunk/include/iprt

Timestamp:

Mar 23, 2011 4:35:01 PM (14 years ago)

Author:

vboxsync

Message:

RTR0MemObjSize: Correct documentation and added alignment guarantee.

File:

• trunk/include/iprt/memobj.h (modified) (1 diff)

trunk/include/iprt/memobj.h

@@ -84 +84 @@
  * Gets the size of a ring-0 memory object.
  *
- * @returns The address of the memory object.
- * @returns NULL if the handle is invalid (asserts in strict builds) or if there isn't any mapping.
+ * The returned value may differ from the one specified to the API creating the
+ * object because of alignment adjustments.  The minimal alignment currently
+ * employed by any API is PAGE_SIZE, so the result can safely be shifted by
+ * PAGE_SHIFT to calculate a page count.
+ *
+ * @returns The object size.
+ * @returns 0 if the handle is invalid (asserts in strict builds) or if there isn't any mapping.
  * @param   MemObj  The ring-0 memory object handle.
  */