xref: /freebsd/share/man/man3/pthread_detach.3 (revision d8a7868820265181ac2d938dcbcc10c3f199d583)
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 BSD 4
36.Sh NAME
37.Nm pthread_detach
38.Nd detach a thread
39.Sh LIBRARY
40.Lb libc_r
41.Sh SYNOPSIS
42.Fd #include <pthread.h>
43.Ft int
44.Fn pthread_detach "pthread_t thread"
45.Sh DESCRIPTION
46The
47.Fn pthread_detach
48function is used to indicate to the implementation that storage for the
49thread
50.Fa thread
51can be reclaimed when the thread terminates.
52If
53.Fa thread
54has not terminated,
55.Fn pthread_detach
56will not cause it to terminate.
57The effect of multiple
58.Fn pthread_detach
59calls on the same target thread is unspecified.
60.Sh RETURN VALUES
61If successful,  the
62.Fn pthread_detach
63function will return zero.
64Otherwise an error number will be returned to
65indicate the error.
66Note that the function does not change the value
67of errno as it did for some drafts of the standard.
68These early drafts
69also passed a pointer to pthread_t as the argument.
70Beware!
71.Sh ERRORS
72.Fn pthread_detach
73will fail if:
74.Bl -tag -width Er
75.It Bq Er EINVAL
76The implementation has detected that the value specified by
77.Fa thread
78does not refer to a joinable thread.
79.It Bq Er ESRCH
80No thread could be found corresponding to that specified by the given
81thread ID,
82.Fa thread .
83.El
84.Pp
85.Sh SEE ALSO
86.Xr pthread_join 3
87.Sh STANDARDS
88.Fn pthread_detach
89conforms to ISO/IEC 9945-1 ANSI/IEEE
90.Pq Dq Tn POSIX
91Std 1003.1 Second Edition 1996-07-12.
92