[apple/libpthread.git] / man / pthread_key_delete.3

.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by John Birrell.
.\" 4. Neither the name of the author nor the names of any co-contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd April 4, 1996
.Dt PTHREAD_KEY_DELETE 3
.Os
.Sh NAME
.Nm pthread_key_delete
.Nd delete a thread-specific data key
.Sh SYNOPSIS
.In pthread.h
.Ft int
.Fn pthread_key_delete "pthread_key_t key"
.Sh DESCRIPTION
The
.Fn pthread_key_delete
function deletes a thread-specific data key previously returned by
.Fn pthread_key_create .
The thread-specific data values associated with
.Fa key
need not be NULL at the time that
.Fn pthread_key_delete
is called.
It is the responsibility of the application to free any
application storage or perform any cleanup actions for data structures
related to the deleted key or associated thread-specific data in any threads;
this cleanup can be done either before or after
.Fn pthread_key_delete
is called.
Any attempt to use
.Fa key
following the call to
.Fn pthread_key_delete
results in undefined behavior.
.Pp
The
.Fn pthread_key_delete
function is callable from within destructor functions.
Destructor functions
are not invoked by
.Fn pthread_key_delete .
Any destructor function that may have been associated with
.Fa key
will no longer be called upon thread exit.
.Sh RETURN VALUES
If successful, the
.Fn pthread_key_delete
function will return zero.
Otherwise an error number will be returned to
indicate the error.
.Sh ERRORS
The
.Fn pthread_key_delete
function will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The
.Fa key
value is invalid.
.El
.Sh SEE ALSO
.Xr pthread_getspecific 3 ,
.Xr pthread_key_create 3 ,
.Xr pthread_setspecific 3
.Sh STANDARDS
The
.Fn pthread_key_delete
function conforms to
.St -p1003.1-96 .
Commit	Line	Data
f1a1da6c A	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	.\"
2546420a	31	.\" $FreeBSD$
f1a1da6c A	32	.\"
	33	.Dd April 4, 1996
	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 SYNOPSIS
2546420a	40	.In pthread.h
f1a1da6c	41	.Ft int
2546420a	42	.Fn pthread_key_delete "pthread_key_t key"
f1a1da6c A	43	.Sh DESCRIPTION
	44	The
	45	.Fn pthread_key_delete
2546420a	46	function deletes a thread-specific data key previously returned by
f1a1da6c A	47	.Fn pthread_key_create .
	48	The thread-specific data values associated with
	49	.Fa key
	50	need not be NULL at the time that
	51	.Fn pthread_key_delete
	52	is called.
	53	It is the responsibility of the application to free any
	54	application storage or perform any cleanup actions for data structures
	55	related to the deleted key or associated thread-specific data in any threads;
	56	this cleanup can be done either before or after
	57	.Fn pthread_key_delete
	58	is called.
	59	Any attempt to use
	60	.Fa key
	61	following the call to
	62	.Fn pthread_key_delete
	63	results in undefined behavior.
	64	.Pp
	65	The
	66	.Fn pthread_key_delete
	67	function is callable from within destructor functions.
	68	Destructor functions
	69	are not invoked by
	70	.Fn pthread_key_delete .
	71	Any destructor function that may have been associated with
	72	.Fa key
	73	will no longer be called upon thread exit.
	74	.Sh RETURN VALUES
	75	If successful, the
	76	.Fn pthread_key_delete
	77	function will return zero.
2546420a	78	Otherwise an error number will be returned to
f1a1da6c A	79	indicate the error.
f1a1da6c A	80	.Sh ERRORS
2546420a	81	The
f1a1da6c	82	.Fn pthread_key_delete
2546420a	83	function will fail if:
f1a1da6c A	84	.Bl -tag -width Er
	85	.It Bq Er EINVAL
	86	The
	87	.Fa key
	88	value is invalid.
	89	.El
	90	.Sh SEE ALSO
	91	.Xr pthread_getspecific 3 ,
	92	.Xr pthread_key_create 3 ,
	93	.Xr pthread_setspecific 3
	94	.Sh STANDARDS
2546420a	95	The
f1a1da6c	96	.Fn pthread_key_delete
2546420a	97	function conforms to
f1a1da6c	98	.St -p1003.1-96 .