1 .\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Dt PTHREAD_KEY_DELETE 3
35 .Nm pthread_key_delete
36 .Nd delete a thread-specific data key
42 .Fn pthread_key_delete "pthread_key_t key"
45 .Fn pthread_key_delete
46 function deletes a thread-specific data key previously returned by
47 .Fn pthread_key_create .
48 The thread-specific data values associated with
50 need not be NULL at the time that
51 .Fn pthread_key_delete
53 It is the responsibility of the application to free any
54 application storage or perform any cleanup actions for data structures
55 related to the deleted key or associated thread-specific data in any threads;
56 this cleanup can be done either before or after
57 .Fn pthread_key_delete
62 .Fn pthread_key_delete
63 results in undefined behavior.
66 .Fn pthread_key_delete
67 function is callable from within destructor functions.
70 .Fn pthread_key_delete .
71 Any destructor function that may have been associated with
73 will no longer be called upon thread exit.
76 .Fn pthread_key_delete
77 function will return zero.
78 Otherwise an error number will be returned to
82 .Fn pthread_key_delete
83 function will fail if:
91 .Xr pthread_getspecific 3 ,
92 .Xr pthread_key_create 3 ,
93 .Xr pthread_setspecific 3
96 .Fn pthread_key_delete