share/man/man3c/pthread_getspecific.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH PTHREAD_GETSPECIFIC 3C "Mar 23, 2005"
  48 .SH NAME
  49 pthread_getspecific, pthread_setspecific \- manage thread-specific data
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  54 #include <pthread.h>
  55
  56 \fBint\fR \fBpthread_setspecific\fR(\fBpthread_key_t\fR \fIkey\fR, \fBconst void *\fR\fIvalue\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBvoid *\fR\fBpthread_getspecific\fR(\fBpthread_key_t\fR \fIkey\fR);
  62 .fi
  63
  64 .SH DESCRIPTION
  65 .sp
  66 .LP
  67 The \fBpthread_setspecific()\fR function associates a thread-specific
  68 \fIvalue\fR with a \fIkey\fR obtained by way of a previous call to
  69 \fBpthread_key_create()\fR. Different threads may bind different values to the
  70 same key. These values are typically pointers to blocks of dynamically
  71 allocated memory that have been reserved for use by the calling thread.
  72 .sp
  73 .LP
  74 The \fBpthread_getspecific()\fR function returns the value currently bound to
  75 the specified \fIkey\fR on behalf of the calling thread.
  76 .sp
  77 .LP
  78 The effect of calling \fBpthread_setspecific()\fR or
  79 \fBpthread_getspecific()\fR with a \fIkey\fR value not obtained from
  80 \fBpthread_key_create()\fR or after \fIkey\fR has been deleted with
  81 \fBpthread_key_delete()\fR is undefined.
  82 .sp
  83 .LP
  84 Both \fBpthread_setspecific()\fR and \fBpthread_getspecific()\fR may be called
  85 from a thread-specific data destructor function. However, calling
  86 \fBpthread_setspecific()\fR from a destructor may result in lost storage or
  87 infinite loops.
  88 .SH RETURN VALUES
  89 .sp
  90 .LP
  91 The  \fBpthread_getspecific()\fR function returns the thread-specific data
  92 value associated with the given \fIkey\fR. If no thread-specific data value is
  93 associated with \fIkey\fR, then the value \fINULL\fR is returned.
  94 .sp
  95 .LP
  96 Upon successful completion, the \fBpthread_setspecific()\fR function returns
  97 \fB0\fR. Otherwise, an error number is returned to indicate the error.
  98 .SH ERRORS
  99 .sp
 100 .LP
 101 The  \fBpthread_setspecific()\fR function will fail if:
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBENOMEM\fR\fR
 106 .ad
 107 .RS 10n
 108 Insufficient memory exists to associate the value with the key.
 109 .RE
 110
 111 .sp
 112 .LP
 113 The \fBpthread_setspecific()\fR function may fail if:
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBEINVAL\fR\fR
 118 .ad
 119 .RS 10n
 120 The key value is invalid.
 121 .RE
 122
 123 .sp
 124 .LP
 125 The  \fBpthread_getspecific()\fR function does not  return errors.
 126 .SH ATTRIBUTES
 127 .sp
 128 .LP
 129 See \fBattributes\fR(5) for descriptions of the following attributes:
 130 .sp
 131
 132 .sp
 133 .TS
 134 box;
 135 c | c
 136 l | l .
 137 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 138 _
 139 Interface Stability     Standard
 140 _
 141 MT-Level        MT-Safe
 142 .TE
 143
 144 .SH SEE ALSO
 145 .sp
 146 .LP
 147 \fBpthread_key_create\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)