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