usr/src/man/man3c/pthread_key_delete.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_KEY_DELETE 3C "Mar 23, 2005"
  48 .SH NAME
  49 pthread_key_delete \- delete thread-specific data key
  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_key_delete\fR(\fBpthread_key_t\fR \fIkey\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 The \fBpthread_key_delete()\fR function deletes a thread-specific data key
  63 previously returned by \fBpthread_key_create()\fR. The thread-specific data
  64 values associated with \fIkey\fR need not be  \fINULL\fR at the time
  65 \fBpthread_key_delete()\fR is called. It is the responsibility of the
  66 application to free any application storage or perform any cleanup actions for
  67 data structures related to the deleted key or associated thread-specific data
  68 in any threads; this cleanup can be done either before or after
  69 \fBpthread_key_delete()\fR is called. Any attempt to use \fIkey\fR following
  70 the call to \fBpthread_key_delete()\fR results in undefined behaviour.
  71 .sp
  72 .LP
  73 The \fBpthread_key_delete()\fR function is callable from within destructor
  74 functions. No destructor functions will be invoked by
  75 \fBpthread_key_delete()\fR. Any destructor function that may have been
  76 associated with \fIkey\fR will no longer be called upon thread exit.
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 If successful, the \fBpthread_key_delete()\fR function returns  \fB0\fR.
  81 Otherwise, an error number is returned to indicate the error.
  82 .SH ERRORS
  83 .sp
  84 .LP
  85 The \fBpthread_key_delete()\fR function may fail if:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBEINVAL\fR\fR
  90 .ad
  91 .RS 10n
  92 The \fIkey\fR value is invalid.
  93 .RE
  94
  95 .sp
  96 .LP
  97 The \fBpthread_key_delete()\fR function will not return an error code of
  98 \fBEINTR\fR.
  99 .SH ATTRIBUTES
 100 .sp
 101 .LP
 102 See \fBattributes\fR(5) for descriptions of the following attributes:
 103 .sp
 104
 105 .sp
 106 .TS
 107 box;
 108 c | c
 109 l | l .
 110 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 111 _
 112 Interface Stability     Standard
 113 _
 114 MT-Level        MT-Safe
 115 .TE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBpthread_key_create\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)