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