xref: /illumos-gate/usr/src/man/man3c/pthread_detach.3c (revision 8a2b682e57a046b828f37bcde1776f131ef4629f)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1991, 1992, 1994, The X/Open Company Ltd.
Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.

PTHREAD_DETACH 3C "Mar 23, 2005"
NAME
pthread_detach - detach a thread
SYNOPSIS

cc -mt [ flag... ] file... -lpthread [ library... ]
#include <pthread.h>

int pthread_detach(pthread_t thread);
DESCRIPTION

The pthread_detach() function is used to indicate to the implementation that storage for the thread thread can be reclaimed when that thread terminates. In other words, pthread_detach() dynamically resets the detachstate attribute of the thread to PTHREAD_CREATE_DETACHED. After a successful call to this function, it would not be necessary to reclaim the thread using pthread_join(). See pthread_join(3C). If thread has not terminated, pthread_detach() will not cause it to terminate. The effect of multiple pthread_detach() calls on the same target thread is unspecified.

RETURN VALUES

If successful, pthread_detach() returns 0. Otherwise, an error number is returned to indicate the error.

ERRORS

The pthread_detach() function will fail if: EINVAL

The implementation has detected that the value specified by thread does not refer to a joinable thread.

ESRCH

No thread could be found corresponding to that specified by the given thread ID.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

pthread_create(3C), pthread_join(3C), attributes(5), standards(5)