usr/src/man/man3c/pthread_detach.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH PTHREAD_DETACH 3C "Mar 23, 2005"
  48 .SH NAME
  49 pthread_detach \- detach a thread
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  54 #include <pthread.h>
  55
  56 \fBint\fR \fBpthread_detach\fR(\fBpthread_t\fR \fIthread\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 The \fBpthread_detach()\fR function is used to indicate to the implementation
  63 that storage for the thread \fIthread\fR can be reclaimed when that thread
  64 terminates. In other words,  \fBpthread_detach()\fR dynamically resets the
  65 \fIdetachstate\fR attribute of the thread to \fBPTHREAD_CREATE_DETACHED.\fR
  66 After a successful call to this function, it would not be necessary to reclaim
  67 the thread using  \fBpthread_join()\fR. See \fBpthread_join\fR(3C). If
  68 \fIthread\fR has not terminated, \fBpthread_detach()\fR will not cause it to
  69 terminate. The effect of multiple \fBpthread_detach()\fR calls on the same
  70 target thread is unspecified.
  71 .SH RETURN VALUES
  72 .sp
  73 .LP
  74 If successful, \fBpthread_detach()\fR returns  \fB0\fR. Otherwise, an error
  75 number is returned to indicate the error.
  76 .SH ERRORS
  77 .sp
  78 .LP
  79 The  \fBpthread_detach()\fR function will fail if:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBEINVAL\fR\fR
  84 .ad
  85 .RS 10n
  86 The implementation has detected that the value specified by \fIthread\fR does
  87 not refer to a joinable thread.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBESRCH\fR\fR
  94 .ad
  95 .RS 10n
  96 No thread could be found corresponding to that specified by the given thread
  97 \fBID.\fR
  98 .RE
  99
 100 .SH ATTRIBUTES
 101 .sp
 102 .LP
 103 See \fBattributes\fR(5) for descriptions of the following attributes:
 104 .sp
 105
 106 .sp
 107 .TS
 108 box;
 109 c | c
 110 l | l .
 111 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 112 _
 113 Interface Stability     Standard
 114 _
 115 MT-Level        MT-Safe
 116 .TE
 117
 118 .SH SEE ALSO
 119 .sp
 120 .LP
 121 \fBpthread_create\fR(3C), \fBpthread_join\fR(3C), \fBattributes\fR(5),
 122 \fBstandards\fR(5)