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