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