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