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