usr/src/man/man3c/pthread_key_delete.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_KEY_DELETE 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_key_delete \- delete thread-specific data key
  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_key_delete\fR(\fBpthread_key_t\fR \fIkey\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBpthread_key_delete()\fR function deletes a thread-specific data key
  28 previously returned by \fBpthread_key_create()\fR. The thread-specific data
  29 values associated with \fIkey\fR need not be  \fINULL\fR at the time
  30 \fBpthread_key_delete()\fR is called. It is the responsibility of the
  31 application to free any application storage or perform any cleanup actions for
  32 data structures related to the deleted key or associated thread-specific data
  33 in any threads; this cleanup can be done either before or after
  34 \fBpthread_key_delete()\fR is called. Any attempt to use \fIkey\fR following
  35 the call to \fBpthread_key_delete()\fR results in undefined behaviour.
  36 .sp
  37 .LP
  38 The \fBpthread_key_delete()\fR function is callable from within destructor
  39 functions. No destructor functions will be invoked by
  40 \fBpthread_key_delete()\fR. Any destructor function that may have been
  41 associated with \fIkey\fR will no longer be called upon thread exit.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 If successful, the \fBpthread_key_delete()\fR function returns  \fB0\fR.
  46 Otherwise, an error number is returned to indicate the error.
  47 .SH ERRORS
  48 .sp
  49 .LP
  50 The \fBpthread_key_delete()\fR function may fail if:
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBEINVAL\fR\fR
  55 .ad
  56 .RS 10n
  57 The \fIkey\fR value is invalid.
  58 .RE
  59
  60 .sp
  61 .LP
  62 The \fBpthread_key_delete()\fR function will not return an error code of
  63 \fBEINTR\fR.
  64 .SH ATTRIBUTES
  65 .sp
  66 .LP
  67 See \fBattributes\fR(5) for descriptions of the following attributes:
  68 .sp
  69
  70 .sp
  71 .TS
  72 box;
  73 c | c
  74 l | l .
  75 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  76 _
  77 Interface Stability     Standard
  78 _
  79 MT-Level        MT-Safe
  80 .TE
  81
  82 .SH SEE ALSO
  83 .sp
  84 .LP
  85 \fBpthread_key_create\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)