usr/src/man/man3c/pthread_getspecific.3c

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