1*e401f658Sschwarze.\" $OpenBSD: pthread_setspecific.3,v 1.13 2017/01/27 15:47:47 schwarze Exp $ 282d2d131Sfgsch.\" 3a278733dSd.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>. 4a278733dSd.\" All rights reserved. 5a278733dSd.\" 6a278733dSd.\" Redistribution and use in source and binary forms, with or without 7a278733dSd.\" modification, are permitted provided that the following conditions 8a278733dSd.\" are met: 9a278733dSd.\" 1. Redistributions of source code must retain the above copyright 10a278733dSd.\" notice, this list of conditions and the following disclaimer. 11a278733dSd.\" 2. Redistributions in binary form must reproduce the above copyright 12a278733dSd.\" notice, this list of conditions and the following disclaimer in the 13a278733dSd.\" documentation and/or other materials provided with the distribution. 14a278733dSd.\" 3. All advertising materials mentioning features or use of this software 15a278733dSd.\" must display the following acknowledgement: 16a278733dSd.\" This product includes software developed by John Birrell. 17a278733dSd.\" 4. Neither the name of the author nor the names of any co-contributors 18a278733dSd.\" may be used to endorse or promote products derived from this software 19a278733dSd.\" without specific prior written permission. 20a278733dSd.\" 21a278733dSd.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 22a278733dSd.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23a278733dSd.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24a278733dSd.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25a278733dSd.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26a278733dSd.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27a278733dSd.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28a278733dSd.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29a278733dSd.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30a278733dSd.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31a278733dSd.\" SUCH DAMAGE. 32a278733dSd.\" 3374493c91Sd.\" $FreeBSD: pthread_setspecific.3,v 1.5 1999/08/28 00:03:11 peter Exp $ 3474493c91Sd.\" 35*e401f658Sschwarze.Dd $Mdocdate: January 27 2017 $ 36a278733dSd.Dt PTHREAD_SETSPECIFIC 3 37c043c0f7Sd.Os 38a278733dSd.Sh NAME 39a278733dSd.Nm pthread_setspecific 40a278733dSd.Nd set a thread-specific data value 41a278733dSd.Sh SYNOPSIS 4286f9d4cdStedu.In pthread.h 43a278733dSd.Ft int 44a278733dSd.Fn pthread_setspecific "pthread_key_t key" "const void *value" 45a278733dSd.Sh DESCRIPTION 46a278733dSdThe 47a278733dSd.Fn pthread_setspecific 48a278733dSdfunction associates a thread-specific value with a 49a278733dSd.Fa key 50a278733dSdobtained via a previous call to 51a278733dSd.Fn pthread_key_create . 52*e401f658SschwarzeDifferent threads may bind different values to the same key. 53*e401f658SschwarzeThese values are 54a278733dSdtypically pointers to blocks of dynamically allocated memory that have been 55a278733dSdreserved for use by the calling thread. 56a278733dSd.Pp 57a278733dSdThe effect of calling 58a278733dSd.Fn pthread_setspecific 59a278733dSdwith a key value not obtained from 6082d2d131Sfgsch.Fn pthread_key_create 61a278733dSdor after 62a278733dSd.Fa key 63a278733dSdhas been deleted with 6482d2d131Sfgsch.Fn pthread_key_delete 65a278733dSdis undefined. 66a278733dSd.Pp 67a278733dSd.Fn pthread_setspecific 68fff41271Spjanzenmay be called from a thread-specific data destructor function; however, this 69a278733dSdmay result in lost storage or infinite loops. 70a278733dSd.Sh RETURN VALUES 71a278733dSdIf successful, the 72a278733dSd.Fn pthread_setspecific 73ee997aeaSmpechfunction will return zero. 74ee997aeaSmpechOtherwise an error number will be returned to indicate the error. 75a278733dSd.Sh ERRORS 76a278733dSd.Fn pthread_setspecific 77a278733dSdwill fail if: 78a278733dSd.Bl -tag -width Er 79a278733dSd.It Bq Er ENOMEM 80a278733dSdInsufficient memory exists to associate the value with the 81a278733dSd.Fa key . 82a278733dSd.It Bq Er EINVAL 83a278733dSdThe 84a278733dSd.Fa key 85a278733dSdvalue is invalid. 86a278733dSd.El 87a278733dSd.Sh SEE ALSO 88a278733dSd.Xr pthread_getspecific 3 , 89a278733dSd.Xr pthread_key_create 3 , 90a278733dSd.Xr pthread_key_delete 3 91a278733dSd.Sh STANDARDS 92a278733dSd.Fn pthread_setspecific 9382d2d131Sfgschconforms to 9482d2d131Sfgsch.St -p1003.1-96 . 95