lib/libpthread/man/pthread_detach.3

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