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