1*86f9d4cdStedu.\" $OpenBSD: pthread_key_delete.3,v 1.10 2013/06/05 03:44:50 tedu Exp $ 282d2d131Sfgsch.\" 3a278733dSd.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>. 4a278733dSd.\" All rights reserved. 5a278733dSd.\" 6a278733dSd.\" Redistribution and use in source and binary forms, with or without 7a278733dSd.\" modification, are permitted provided that the following conditions 8a278733dSd.\" are met: 9a278733dSd.\" 1. Redistributions of source code must retain the above copyright 10a278733dSd.\" notice, this list of conditions and the following disclaimer. 11a278733dSd.\" 2. Redistributions in binary form must reproduce the above copyright 12a278733dSd.\" notice, this list of conditions and the following disclaimer in the 13a278733dSd.\" documentation and/or other materials provided with the distribution. 14a278733dSd.\" 3. All advertising materials mentioning features or use of this software 15a278733dSd.\" must display the following acknowledgement: 16a278733dSd.\" This product includes software developed by John Birrell. 17a278733dSd.\" 4. Neither the name of the author nor the names of any co-contributors 18a278733dSd.\" may be used to endorse or promote products derived from this software 19a278733dSd.\" without specific prior written permission. 20a278733dSd.\" 21a278733dSd.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 22a278733dSd.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23a278733dSd.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24a278733dSd.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25a278733dSd.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26a278733dSd.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27a278733dSd.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28a278733dSd.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29a278733dSd.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30a278733dSd.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31a278733dSd.\" SUCH DAMAGE. 32a278733dSd.\" 3374493c91Sd.\" $FreeBSD: pthread_key_delete.3,v 1.5 1999/08/28 00:03:06 peter Exp $ 3474493c91Sd.\" 35*86f9d4cdStedu.Dd $Mdocdate: June 5 2013 $ 36a278733dSd.Dt PTHREAD_KEY_DELETE 3 37c043c0f7Sd.Os 38a278733dSd.Sh NAME 39a278733dSd.Nm pthread_key_delete 40a278733dSd.Nd delete a thread-specific data key 41a278733dSd.Sh SYNOPSIS 42*86f9d4cdStedu.In pthread.h 43a278733dSd.Ft int 44a278733dSd.Fn pthread_key_delete "pthread_key_t key" 45a278733dSd.Sh DESCRIPTION 46a278733dSdThe 47a278733dSd.Fn pthread_key_delete 48a278733dSdfunction deletes a thread-specific data key previously returned by 49a278733dSd.Fn pthread_key_create . 50a278733dSdThe thread-specific data values associated with 51a278733dSd.Fa key 52a278733dSdneed not be NULL at the time that 53a278733dSd.Fn pthread_key_delete 54ee997aeaSmpechis called. 55ee997aeaSmpechIt is the responsibility of the application to free any 56a278733dSdapplication storage or perform any cleanup actions for data structures 57a278733dSdrelated to the deleted key or associated thread-specific data in any threads; 58a278733dSdthis cleanup can be done either before or after 59a278733dSd.Fn pthread_key_delete 60ee997aeaSmpechis called. 61ee997aeaSmpechAny attempt to use 62a278733dSd.Fa key 63a278733dSdfollowing the call to 64a278733dSd.Fn pthread_key_delete 65a278733dSdresults in undefined behavior. 66a278733dSd.Pp 67a278733dSdThe 68a278733dSd.Fn pthread_key_delete 69ee997aeaSmpechfunction is callable from within destructor functions. 70ee997aeaSmpechDestructor functions are not invoked by 71a278733dSd.Fn pthread_key_delete . 72a278733dSdAny destructor function that may have been associated with 73a278733dSd.Fa key 74a278733dSdwill no longer be called upon thread exit. 75a278733dSd.Sh RETURN VALUES 76a278733dSdIf successful, the 77a278733dSd.Fn pthread_key_delete 78ee997aeaSmpechfunction will return zero. 79ee997aeaSmpechOtherwise an error number will be returned to indicate the error. 80a278733dSd.Sh ERRORS 81a278733dSd.Fn pthread_key_delete 82a278733dSdwill fail if: 83a278733dSd.Bl -tag -width Er 84a278733dSd.It Bq Er EINVAL 85a278733dSdThe 86a278733dSd.Fa key 87a278733dSdvalue is invalid. 88a278733dSd.El 89a278733dSd.Sh SEE ALSO 90a278733dSd.Xr pthread_getspecific 3 , 91a278733dSd.Xr pthread_key_create 3 , 92a278733dSd.Xr pthread_setspecific 3 93a278733dSd.Sh STANDARDS 94a278733dSd.Fn pthread_key_delete 9582d2d131Sfgschconforms to 9682d2d131Sfgsch.St -p1003.1-96 . 97