lib/libpthread/pthread_key_delete.3

   1 .\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by John Birrell.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD: src/share/man/man3/pthread_key_delete.3,v 1.16 2007/10/22 10:08:00 ru Exp $
  32 .\" $DragonFly: src/lib/libc_r/man/pthread_key_delete.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  33 .\"
  34 .Dd July 10, 2009
  35 .Dt PTHREAD_KEY_DELETE 3
  36 .Os
  37 .Sh NAME
  38 .Nm pthread_key_delete
  39 .Nd delete a thread-specific data key
  40 .Sh LIBRARY
  41 .Lb libpthread
  42 .Sh SYNOPSIS
  43 .In pthread.h
  44 .Ft int
  45 .Fn pthread_key_delete "pthread_key_t key"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn pthread_key_delete
  49 function deletes a thread-specific data key previously returned by
  50 .Fn pthread_key_create .
  51 The thread-specific data values associated with
  52 .Fa key
  53 need not be NULL at the time that
  54 .Fn pthread_key_delete
  55 is called.
  56 It is the responsibility of the application to free any
  57 application storage or perform any cleanup actions for data structures
  58 related to the deleted key or associated thread-specific data in any threads;
  59 this cleanup can be done either before or after
  60 .Fn pthread_key_delete
  61 is called.
  62 Any attempt to use
  63 .Fa key
  64 following the call to
  65 .Fn pthread_key_delete
  66 results in undefined behavior.
  67 .Pp
  68 The
  69 .Fn pthread_key_delete
  70 function is callable from within destructor functions.
  71 Destructor functions
  72 are not invoked by
  73 .Fn pthread_key_delete .
  74 Any destructor function that may have been associated with
  75 .Fa key
  76 will no longer be called upon thread exit.
  77 .Sh RETURN VALUES
  78 If successful, the
  79 .Fn pthread_key_delete
  80 function will return zero.
  81 Otherwise an error number will be returned to
  82 indicate the error.
  83 .Sh ERRORS
  84 The
  85 .Fn pthread_key_delete
  86 function will fail if:
  87 .Bl -tag -width Er
  88 .It Bq Er EINVAL
  89 The
  90 .Fa key
  91 value is invalid.
  92 .El
  93 .Sh SEE ALSO
  94 .Xr pthread_getspecific 3 ,
  95 .Xr pthread_key_create 3 ,
  96 .Xr pthread_setspecific 3
  97 .Sh STANDARDS
  98 The
  99 .Fn pthread_key_delete
 100 function conforms to
 101 .St -p1003.1-96 .