1.\" $OpenBSD: pthread_key_delete.3,v 1.10 2013/06/05 03:44:50 tedu Exp $ 2.\" 3.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by John Birrell. 17.\" 4. Neither the name of the author nor the names of any co-contributors 18.\" may be used to endorse or promote products derived from this software 19.\" without specific prior written permission. 20.\" 21.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31.\" SUCH DAMAGE. 32.\" 33.\" $FreeBSD: pthread_key_delete.3,v 1.5 1999/08/28 00:03:06 peter Exp $ 34.\" 35.Dd $Mdocdate: June 5 2013 $ 36.Dt PTHREAD_KEY_DELETE 3 37.Os 38.Sh NAME 39.Nm pthread_key_delete 40.Nd delete a thread-specific data key 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 are not invoked by 71.Fn pthread_key_delete . 72Any destructor function that may have been associated with 73.Fa key 74will no longer be called upon thread exit. 75.Sh RETURN VALUES 76If successful, the 77.Fn pthread_key_delete 78function will return zero. 79Otherwise an error number will be returned to indicate the error. 80.Sh ERRORS 81.Fn pthread_key_delete 82will fail if: 83.Bl -tag -width Er 84.It Bq Er EINVAL 85The 86.Fa key 87value is invalid. 88.El 89.Sh SEE ALSO 90.Xr pthread_getspecific 3 , 91.Xr pthread_key_create 3 , 92.Xr pthread_setspecific 3 93.Sh STANDARDS 94.Fn pthread_key_delete 95conforms to 96.St -p1003.1-96 . 97