iprt

Timestamp:

Dec 10, 2009 12:57:31 PM (15 years ago)

Author:

vboxsync

Message:

IPRT: docs

File:

trunk/include/iprt/thread.h

-              r23124
+              r25294
 /**
+ * Allocates a TLS entry.
+ * Allocates a TLS entry (index). Before using an item of TLS, this must be called
+ * once for the process; the RTTLS value returned is then typically stored in a global
+ * or static variable. See RTTlsGet() for example code.
+ *
  * @returns the index of the allocated TLS entry.
 …
 /**
  * Allocates a TLS entry (with status code).
+ * Allocates a TLS entry (index, with status code).
+ *
  * @returns IPRT status code.
 …
 /**
+ * Get the value stored in a TLS entry.
+ * Get the (thread-local) value stored in a TLS entry.
+ * If RTTlsSet() has not yet been called, returns NULL.
+ *
+ * Example code:
+ * <code>
+ * RTTLS g_globalTLSIndex = NIL_RTTLS;
+ *
+ * ...
+ *
+ * // once for the process, allocate the TLS index
+ * if (g_globalTLSIndex == NIL_RTTLS)
+ *      g_globalTLSIndex = RTTlsAlloc();
+ *
+ * // get the thread-local value
+ * void* pv = RTTlsGet(g_globalTLSIndex);
+ *
+ * </code>
+ *
  * @returns value in given TLS entry.
 …
  * @param   pvValue     The value to store.
+ *
  * @remarks Note that NULL is considered to special value.
+ * @remarks Note that NULL is considered a special value.
  */
 RTR3DECL(int) RTTlsSet(RTTLS iTls, void *pvValue);

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