1.\" $OpenBSD: pthread_setspecific.3,v 1.8 2001/06/24 23:46:35 jasoni Exp $ 2.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>. 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. All advertising materials mentioning features or use of this software 14.\" must display the following acknowledgement: 15.\" This product includes software developed by John Birrell. 16.\" 4. Neither the name of the author nor the names of any co-contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" $FreeBSD: pthread_setspecific.3,v 1.5 1999/08/28 00:03:11 peter Exp $ 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 SYNOPSIS 41.Fd #include <pthread.h> 42.Ft int 43.Fn pthread_setspecific "pthread_key_t key" "const void *value" 44.Sh DESCRIPTION 45The 46.Fn pthread_setspecific 47function associates a thread-specific value with a 48.Fa key 49obtained via a previous call to 50.Fn pthread_key_create . 51Different threads may bind different values to the same key. These values are 52typically pointers to blocks of dynamically allocated memory that have been 53reserved for use by the calling thread. 54.Pp 55The effect of calling 56.Fn pthread_setspecific 57with a key value not obtained from 58.Fn pthread_key_create , 59or after 60.Fa key 61has been deleted with 62.Fn pthread_key_delete , 63is undefined. 64.Pp 65.Fn pthread_setspecific 66may be called from a thread-specific data destructor function; however, this 67may result in lost storage or infinite loops. 68.Sh RETURN VALUES 69If successful, the 70.Fn pthread_setspecific 71function will return zero. Otherwise an error number will be returned to 72indicate the error. 73.Sh ERRORS 74.Fn pthread_setspecific 75will fail if: 76.Bl -tag -width Er 77.It Bq Er ENOMEM 78Insufficient memory exists to associate the value with the 79.Fa key . 80.It Bq Er EINVAL 81The 82.Fa key 83value is invalid. 84.El 85.Sh SEE ALSO 86.Xr pthread_getspecific 3 , 87.Xr pthread_key_create 3 , 88.Xr pthread_key_delete 3 89.Sh STANDARDS 90.Fn pthread_setspecific 91conforms to ISO/IEC 9945-1 ANSI/IEEE 92.Pq Dq Tn POSIX 93Std 1003.1 Second Edition 1996-07-12. 94