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.Dd April 4, 1996 32.Dt PTHREAD_SETSPECIFIC 3 33.Os BSD 4 34.Sh NAME 35.Nm pthread_setspecific 36.Nd set a thread-specific data value 37.Sh SYNOPSIS 38.Fd #include <pthread.h> 39.Ft int 40.Fn pthread_setspecific "pthread_key_t key" "const void *value" 41.Sh DESCRIPTION 42The 43.Fn pthread_setspecific 44function associates a thread-specific value with a 45.Fa key 46obtained via a previous call to 47.Fn pthread_key_create . 48Different threads man bind different values to the same key. These values are 49typically pointers to blocks of dynamically allocated memory that have been 50reserved for use by the calling thread. 51.Pp 52The effect of calling 53.Fn pthread_setspecific 54with a key value not obtained from 55.Fn pthread_key_create 56or after 57.Fa key 58has been deleted with 59.Fn pthread_key_delete 60is undefined. 61.Pp 62.Fn pthread_setspecific 63may be called from a thread-specific data destructor function, however this 64may result in lost storage or infinite loops. 65.Sh RETURN VALUES 66If successful, the 67.Fn pthread_setspecific 68function will return zero. Otherwise an error number will be returned to 69indicate the error. 70.Sh ERRORS 71.Fn pthread_setspecific 72will fail if: 73.Bl -tag -width Er 74.It Bq Er ENOMEM 75Insufficient memory exists to associate the value with the 76.Fa key . 77.It Bq Er EINVAL 78The 79.Fa key 80value is invalid. 81.El 82.Pp 83.Sh SEE ALSO 84.Xr pthread_getspecific 3 , 85.Xr pthread_key_create 3 , 86.Xr pthread_key_delete 3 87.Sh STANDARDS 88.Fn pthread_setspecific 89conforms to ISO/IEC 9945-1 ANSI/IEEE 90.Pq Dq Tn POSIX 91Std 1003.1 Second Edition 1996-07-12. 92