projects / apple / libpthread.git / blame
| Commit | Line | Data |
|---|---|---|
| f1a1da6c A |
1 | .\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>. |
| 2 | .\" All rights reserved. | |
| 3 | .\" | |
| 4 | .\" Redistribution and use in source and binary forms, with or without | |
| 5 | .\" modification, are permitted provided that the following conditions | |
| 6 | .\" are met: | |
| 7 | .\" 1. Redistributions of source code must retain the above copyright | |
| 8 | .\" notice, this list of conditions and the following disclaimer. | |
| 9 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
| 10 | .\" notice, this list of conditions and the following disclaimer in the | |
| 11 | .\" documentation and/or other materials provided with the distribution. | |
| 12 | .\" 3. All advertising materials mentioning features or use of this software | |
| 13 | .\" must display the following acknowledgement: | |
| 14 | .\" This product includes software developed by John Birrell. | |
| 15 | .\" 4. Neither the name of the author nor the names of any co-contributors | |
| 16 | .\" may be used to endorse or promote products derived from this software | |
| 17 | .\" without specific prior written permission. | |
| 18 | .\" | |
| 19 | .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND | |
| 20 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 21 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 22 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
| 23 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
| 24 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
| 25 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
| 26 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
| 27 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
| 28 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
| 29 | .\" SUCH DAMAGE. | |
| 30 | .\" | |
| 2546420a | 31 | .\" $FreeBSD$ |
| f1a1da6c A |
32 | .\" |
| 33 | .Dd April 4, 1996 | |
| 34 | .Dt PTHREAD_GETSPECIFIC 3 | |
| 35 | .Os | |
| 36 | .Sh NAME | |
| 37 | .Nm pthread_getspecific | |
| 38 | .Nd get a thread-specific data value | |
| 39 | .Sh SYNOPSIS | |
| 2546420a | 40 | .In pthread.h |
| f1a1da6c | 41 | .Ft void * |
| 2546420a | 42 | .Fn pthread_getspecific "pthread_key_t key" |
| f1a1da6c A |
43 | .Sh DESCRIPTION |
| 44 | The | |
| 45 | .Fn pthread_getspecific | |
| 2546420a A |
46 | function returns the value currently bound to the specified |
| 47 | .Fa key | |
| f1a1da6c A |
48 | on behalf of the calling thread. |
| 49 | .Pp | |
| 50 | The effect of calling | |
| 51 | .Fn pthread_getspecific | |
| 52 | with a | |
| 53 | .Fa key | |
| 2546420a A |
54 | value not obtained from |
| 55 | .Fn pthread_key_create | |
| 56 | or after | |
| f1a1da6c A |
57 | .Fa key |
| 58 | has been deleted with | |
| 2546420a | 59 | .Fn pthread_key_delete |
| f1a1da6c A |
60 | is undefined. |
| 61 | .Pp | |
| 2546420a | 62 | The |
| f1a1da6c | 63 | .Fn pthread_getspecific |
| 2546420a | 64 | function may be called from a thread-specific data destructor function. |
| f1a1da6c A |
65 | .Sh RETURN VALUES |
| 66 | The | |
| 67 | .Fn pthread_getspecific | |
| 68 | function will return the thread-specific data value associated with the given | |
| 69 | .Fa key . | |
| 70 | If no thread-specific data value is associated with | |
| 71 | .Fa key , | |
| 2546420a | 72 | then the value NULL is returned. |
| f1a1da6c A |
73 | .Sh ERRORS |
| 74 | None. | |
| 75 | .Sh SEE ALSO | |
| 76 | .Xr pthread_key_create 3 , | |
| 77 | .Xr pthread_key_delete 3 , | |
| 78 | .Xr pthread_setspecific 3 | |
| 79 | .Sh STANDARDS | |
| 2546420a | 80 | The |
| f1a1da6c | 81 | .Fn pthread_getspecific |
| 2546420a | 82 | function conforms to |
| f1a1da6c | 83 | .St -p1003.1-96 . |