1.\" $OpenBSD: pthread_detach.3,v 1.8 2001/06/24 18:17:30 jasoni Exp $ 2.\" Copyright (c) 1996-1998 John Birrell <jb@cimlogic.com.au>. 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. All advertising materials mentioning features or use of this software 14.\" must display the following acknowledgement: 15.\" This product includes software developed by John Birrell. 16.\" 4. Neither the name of the author nor the names of any co-contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" $FreeBSD: pthread_detach.3,v 1.5 1999/08/28 00:03:05 peter Exp $ 33.\" 34.Dd April 4, 1996 35.Dt PTHREAD_DETACH 3 36.Os 37.Sh NAME 38.Nm pthread_detach 39.Nd detach a thread 40.Sh SYNOPSIS 41.Fd #include <pthread.h> 42.Ft int 43.Fn pthread_detach "pthread_t thread" 44.Sh DESCRIPTION 45The 46.Fn pthread_detach 47function is used to indicate to the implementation that storage for the 48thread 49.Fa thread 50can be reclaimed when the thread terminates. If 51.Fa thread 52has not terminated, 53.Fn pthread_detach 54will not cause it to terminate. The effect of multiple 55.Fn pthread_detach 56calls on the same target thread is unspecified. 57.Sh RETURN VALUES 58If successful, the 59.Fn pthread_detach 60function will return zero. Otherwise an error number will be returned to 61indicate the error. Note that the function does not change the value 62of 63.Va errno 64as it did for some drafts of the standard. These early drafts 65also passed a pointer to pthread_t as the argument. Beware! 66.Sh ERRORS 67.Fn pthread_detach 68will fail if: 69.Bl -tag -width Er 70.It Bq Er EINVAL 71The implementation has detected that the value specified by 72.Fa thread 73does not refer to a joinable thread. 74.It Bq Er ESRCH 75No thread could be found corresponding to that specified by the given 76thread ID, 77.Fa thread . 78.El 79.Sh SEE ALSO 80.Xr pthread_join 3 81.Sh STANDARDS 82.Fn pthread_detach 83conforms to ISO/IEC 9945-1 ANSI/IEEE 84.Pq Dq Tn POSIX 85Std 1003.1 Second Edition 1996-07-12. 86