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