Merge remote branch 'crater/vendor/MDOCML' into HEAD
[dragonfly.git] / lib / libpthread / pthread_setspecific.3
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/share/man/man3/pthread_setspecific.3,v 1.17 2007/10/22 10:08:01 ru Exp $
32 .\" $DragonFly: src/lib/libc_r/man/pthread_setspecific.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
33 .\"
34 .Dd July 10, 2009
35 .Dt PTHREAD_SETSPECIFIC 3
36 .Os
37 .Sh NAME
38 .Nm pthread_setspecific
39 .Nd set a thread-specific data value
40 .Sh LIBRARY
41 .Lb libpthread
42 .Sh SYNOPSIS
43 .In pthread.h
44 .Ft int
45 .Fn pthread_setspecific "pthread_key_t key" "const void *value"
46 .Sh DESCRIPTION
47 The
48 .Fn pthread_setspecific
49 function associates a thread-specific value with a
50 .Fa key
51 obtained via a previous call to
52 .Fn pthread_key_create .
53 Different threads can bind different values to the same key.
54 These values are
55 typically pointers to blocks of dynamically allocated memory that have been
56 reserved for use by the calling thread.
57 .Pp
58 The effect of calling
59 .Fn pthread_setspecific
60 with a key value not obtained from
61 .Fn pthread_key_create
62 or after
63 .Fa key
64 has been deleted with
65 .Fn pthread_key_delete
66 is undefined.
67 .Pp
68 The
69 .Fn pthread_setspecific
70 function may be called from a thread-specific data destructor function,
71 however this may result in lost storage or infinite loops.
72 .Sh RETURN VALUES
73 If successful, the
74 .Fn pthread_setspecific
75 function will return zero.
76 Otherwise an error number will be returned to
77 indicate the error.
78 .Sh ERRORS
79 The
80 .Fn pthread_setspecific
81 function will fail if:
82 .Bl -tag -width Er
83 .It Bq Er ENOMEM
84 Insufficient memory exists to associate the value with the
85 .Fa key .
86 .It Bq Er EINVAL
87 The
88 .Fa key
89 value is invalid.
90 .El
91 .Sh SEE ALSO
92 .Xr pthread_getspecific 3 ,
93 .Xr pthread_key_create 3 ,
94 .Xr pthread_key_delete 3
95 .Sh STANDARDS
96 The
97 .Fn pthread_setspecific
98 function conforms to
99 .St -p1003.1-96 .