Changeset 47370 in vbox

Timestamp:

Jul 24, 2013 12:35:39 PM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

87517

Message:

iprt/thread.h: Define/document the return values more explicitly when NIL_RTHREADCTX handles are involved.

Location:

trunk

Files:

trunk/include/iprt/thread.h

-              r47352
+              r47370
  * Releases a reference to a thread-context hook.
+ *
+ * @returns New reference count, if 0 the thread-context hook was freed.
+ *          UINT32_MAX is returned if the handle is invalid (asserted).
+ * @param   phThreadCtx         Pointer to the thread-context handle.
+ * @returns New reference count.
+ * @retval  0 if the thread-context hook was freed or the handle was
+ *          NIL_RTTHREADCTX.
+ * @retval  UINT32_MAX is returned if the handle is invalid (asserted).
+ *
+ * @param   phThreadCtx         Pointer to the thread-context handle (can be
+ *                              NIL_RTTHREADCTX).
+ *
  * @remarks This can be called from any thread but must be called with

r47352	r47370
172	172	if (pThis == NIL_RTTHREADCTX)
173	173	return 0;
	174
174	175	AssertPtr(pThis);
175	176	AssertMsgReturn(pThis->u32Magic == RTTHREADCTXINT_MAGIC, ("pThis->u32Magic=%RX32 pThis=%p\n", pThis->u32Magic, pThis),

Note: See TracChangeset for help on using the changeset viewer.