xref: /freebsd/share/man/man3/pthread_detach.3 (revision e627b39baccd1ec9129690167cf5e6d860509655)
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.\"
31.Dd April 4, 1996
32.Dt PTHREAD_DETACH 3
33.Os BSD 4
34.Sh NAME
35.Nm pthread_detach
36.Nd detach a thread
37.Sh SYNOPSIS
38.Fd #include <pthread.h>
39.Ft int
40.Fn pthread_detach "pthread_t thread"
41.Sh DESCRIPTION
42The
43.Fn pthread_detach
44function is used to indicate to the implementation that storage for the
45thread
46.Fa thread
47can be reclaimed when the thread terminates. If
48.Fa thread
49has not terminated,
50.Fn pthread_detach
51will not cause it to terminate. The effect of multiple
52.Fn pthread_detach
53calls on the same target thread is unspecified.
54.Sh RETURN VALUES
55If successful,  the
56.Fn pthread_detach
57function will return zero. Otherwise an error number will be returned to
58indicate the error.
59.Sh ERRORS
60.Fn pthread_detach
61will fail if:
62.Bl -tag -width Er
63.It Bq Er EINVAL
64The implementation has detected that the value specified by
65.Fa thread
66does not refer to a joinable thread.
67.It Bq Er ESRCH
68No thread could be found corresponding to that specified by the given
69thread ID,
70.Fa thread .
71.El
72.Pp
73.Sh SEE ALSO
74.Xr pthread_join 3
75.Sh STANDARDS
76.Fn pthread_detach
77is expected to conform to IEEE
78.Pq Dq Tn POSIX
79Std 1003.1c when it is published.
80