lib/libpthread/pthread_setspecific.3

   1 .\" $NetBSD: pthread_setspecific.3,v 1.2 2003/06/08 06:44:34 thorpej Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   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 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  15 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  16 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  18 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24 .\" POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
  27 .\" All rights reserved.
  28 .\"
  29 .\" Redistribution and use in source and binary forms, with or without
  30 .\" modification, are permitted provided that the following conditions
  31 .\" are met:
  32 .\" 1. Redistributions of source code must retain the above copyright
  33 .\"    notice, this list of conditions and the following disclaimer.
  34 .\" 2. Redistributions in binary form must reproduce the above copyright
  35 .\"    notice, this list of conditions and the following disclaimer in the
  36 .\"    documentation and/or other materials provided with the distribution.
  37 .\" 3. All advertising materials mentioning features or use of this software
  38 .\"    must display the following acknowledgement:
  39 .\"     This product includes software developed by John Birrell.
  40 .\" 4. Neither the name of the author nor the names of any co-contributors
  41 .\"    may be used to endorse or promote products derived from this software
  42 .\"    without specific prior written permission.
  43 .\"
  44 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  45 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  46 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  47 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  48 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  49 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  50 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  51 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  52 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  53 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  54 .\" SUCH DAMAGE.
  55 .\"
  56 .\" $FreeBSD: src/lib/libpthread/man/pthread_setspecific.3,v 1.12 2002/09/16 19:29:29 mini Exp $
  57 .\"
  58 .Dd January 30, 2003
  59 .Dt PTHREAD_SETSPECIFIC 3
  60 .Os
  61 .Sh NAME
  62 .Nm pthread_setspecific
  63 .Nd set a thread-specific data value
  64 .Sh LIBRARY
  65 .Lb libpthread
  66 .Sh SYNOPSIS
  67 .In pthread.h
  68 .Ft int
  69 .Fn pthread_setspecific "pthread_key_t key" "const void *value"
  70 .Sh DESCRIPTION
  71 The
  72 .Fn pthread_setspecific
  73 function associates a thread-specific value with a
  74 .Fa key
  75 obtained via a previous call to
  76 .Fn pthread_key_create .
  77 Different threads have different values bound to each key.
  78 These values are
  79 typically pointers to blocks of dynamically allocated memory that have been
  80 reserved for use by the calling thread.
  81 .Pp
  82 The effect of calling
  83 .Fn pthread_setspecific
  84 with a key value not obtained from
  85 .Fn pthread_key_create
  86 or after
  87 .Fa key
  88 has been deleted with
  89 .Fn pthread_key_delete
  90 is undefined.
  91 .Pp
  92 .Fn pthread_setspecific
  93 may be called from a thread-specific data destructor function, however this
  94 may result in lost storage or infinite loops.
  95 .Sh RETURN VALUES
  96 If successful,  the
  97 .Fn pthread_setspecific
  98 function will return zero.
  99 Otherwise an error number will be returned to
 100 indicate the error.
 101 .Sh ERRORS
 102 .Fn pthread_setspecific
 103 shall fail if:
 104 .Bl -tag -width Er
 105 .It Bq Er ENOMEM
 106 Insufficient memory exists to associate the value with the
 107 .Fa key .
 108 .El
 109 .Pp
 110 .Fn pthread_setspecific
 111 may fail if:
 112 .Bl -tag -width Er
 113 .It Bq Er EINVAL
 114 The
 115 .Fa key
 116 value is invalid.
 117 .El
 118 .Sh SEE ALSO
 119 .Xr pthread_getspecific 3 ,
 120 .Xr pthread_key_create 3 ,
 121 .Xr pthread_key_delete 3
 122 .Sh STANDARDS
 123 .Fn pthread_setspecific
 124 conforms to
 125 .St -p1003.1-96 .