Move pthread* manpages to lib/libpthread as they are not libc_r specific.
[dragonfly.git] / lib / libpthread / pthread_getspecific.3
blobd335177f64fa0e8e853aaa55ca8f280bb592d1ff
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 .\"
31 .\" $FreeBSD: src/lib/libc_r/man/pthread_getspecific.3,v 1.6.2.4 2001/12/17 10:08:26 ru Exp $
32 .\" $DragonFly: src/lib/libc_r/man/pthread_getspecific.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
33 .\"
34 .Dd April 4, 1996
35 .Dt PTHREAD_GETSPECIFIC 3
36 .Os
37 .Sh NAME
38 .Nm pthread_getspecific
39 .Nd get a thread-specific data value
40 .Sh LIBRARY
41 .Lb libc_r
42 .Sh SYNOPSIS
43 .In pthread.h
44 .Ft void *
45 .Fn pthread_getspecific "pthread_key_t key"
46 .Sh DESCRIPTION
47 The
48 .Fn pthread_getspecific
49 function returns the value currently bound to the specified
50 .Fa key
51 on behalf of the calling thread.
52 .Pp
53 The effect of calling
54 .Fn pthread_getspecific
55 with a
56 .Fa key
57 value not obtained from
58 .Fn pthread_key_create
59 or after
60 .Fa key
61 has been deleted with
62 .Fn pthread_key_delete
63 is undefined.
64 .Pp
65 .Fn pthread_getspecific
66 may be called from a thread-specific data destructor function.
67 .Sh RETURN VALUES
68 The
69 .Fn pthread_getspecific
70 function will return the thread-specific data value associated with the given
71 .Fa key .
72 If no thread-specific data value is associated with
73 .Fa key ,
74 then the value NULL is returned.
75 .Sh ERRORS
76 None.
77 .Sh SEE ALSO
78 .Xr pthread_key_create 3 ,
79 .Xr pthread_key_delete 3 ,
80 .Xr pthread_setspecific 3
81 .Sh STANDARDS
82 .Fn pthread_getspecific
83 conforms to
84 .St -p1003.1-96 .