git.saurik.com Git - apple/libpthread.git/blame

Commit	Line	Data
f1a1da6c A	1	.\" Copyright (c) 1996-1998 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_DETACH 3
	35	.Os
	36	.Sh NAME
	37	.Nm pthread_detach
	38	.Nd detach a thread
	39	.Sh SYNOPSIS
2546420a	40	.In pthread.h
f1a1da6c	41	.Ft int
2546420a	42	.Fn pthread_detach "pthread_t thread"
f1a1da6c A	43	.Sh DESCRIPTION
	44	The
	45	.Fn pthread_detach
	46	function is used to indicate to the implementation that storage for the
	47	thread
	48	.Fa thread
	49	can be reclaimed when the thread terminates.
	50	If
	51	.Fa thread
	52	has not terminated,
	53	.Fn pthread_detach
	54	will not cause it to terminate.
	55	The effect of multiple
	56	.Fn pthread_detach
	57	calls on the same target thread is unspecified.
	58	.Sh RETURN VALUES
2546420a	59	If successful, the
f1a1da6c A	60	.Fn pthread_detach
f1a1da6c A	61	function will return zero.
2546420a	62	Otherwise an error number will be returned to
f1a1da6c A	63	indicate the error.
f1a1da6c A	64	Note that the function does not change the value
2546420a	65	of errno as it did for some drafts of the standard.
f1a1da6c A	66	These early drafts
	67	also passed a pointer to pthread_t as the argument.
	68	Beware!
	69	.Sh ERRORS
2546420a	70	The
f1a1da6c	71	.Fn pthread_detach
2546420a	72	function will fail if:
f1a1da6c A	73	.Bl -tag -width Er
	74	.It Bq Er EINVAL
	75	The implementation has detected that the value specified by
	76	.Fa thread
	77	does not refer to a joinable thread.
	78	.It Bq Er ESRCH
	79	No thread could be found corresponding to that specified by the given
	80	thread ID,
	81	.Fa thread .
	82	.El
	83	.Sh SEE ALSO
	84	.Xr pthread_join 3
	85	.Sh STANDARDS
2546420a	86	The
f1a1da6c	87	.Fn pthread_detach
2546420a	88	function conforms to
f1a1da6c	89	.St -p1003.1-96 .