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