share/man/man3/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$
  32 .\"
  33 .Dd April 4, 1996
  34 .Dt PTHREAD_KEY_DELETE 3
  35 .Os
  36 .Sh NAME
  37 .Nm pthread_key_delete
  38 .Nd delete a thread-specific data key
  39 .Sh LIBRARY
  40 .Lb libc_r
  41 .Lb libpthread
  42 .Lb libthr
  43 .Sh SYNOPSIS
  44 .In pthread.h
  45 .Ft int
  46 .Fn pthread_key_delete "pthread_key_t key"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn pthread_key_delete
  50 function deletes a thread-specific data key previously returned by
  51 .Fn pthread_key_create .
  52 The thread-specific data values associated with
  53 .Fa key
  54 need not be NULL at the time that
  55 .Fn pthread_key_delete
  56 is called.
  57 It is the responsibility of the application to free any
  58 application storage or perform any cleanup actions for data structures
  59 related to the deleted key or associated thread-specific data in any threads;
  60 this cleanup can be done either before or after
  61 .Fn pthread_key_delete
  62 is called.
  63 Any attempt to use
  64 .Fa key
  65 following the call to
  66 .Fn pthread_key_delete
  67 results in undefined behavior.
  68 .Pp
  69 The
  70 .Fn pthread_key_delete
  71 function is callable from within destructor functions.
  72 Destructor functions
  73 are not invoked by
  74 .Fn pthread_key_delete .
  75 Any destructor function that may have been associated with
  76 .Fa key
  77 will no longer be called upon thread exit.
  78 .Sh RETURN VALUES
  79 If successful, the
  80 .Fn pthread_key_delete
  81 function will return zero.
  82 Otherwise an error number will be returned to
  83 indicate the error.
  84 .Sh ERRORS
  85 The
  86 .Fn pthread_key_delete
  87 function will fail if:
  88 .Bl -tag -width Er
  89 .It Bq Er EINVAL
  90 The
  91 .Fa key
  92 value is invalid.
  93 .El
  94 .Sh SEE ALSO
  95 .Xr pthread_getspecific 3 ,
  96 .Xr pthread_key_create 3 ,
  97 .Xr pthread_setspecific 3
  98 .Sh STANDARDS
  99 The
 100 .Fn pthread_key_delete
 101 function conforms to
 102 .St -p1003.1-96 .