1.\" $OpenBSD: pthread_join.3,v 1.6 2001/06/24 23:46:35 jasoni Exp $ 2.\" Copyright (c) 1996-1998 John Birrell <jb@cimlogic.com.au>. 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. All advertising materials mentioning features or use of this software 14.\" must display the following acknowledgement: 15.\" This product includes software developed by John Birrell. 16.\" 4. Neither the name of the author nor the names of any co-contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" $FreeBSD: pthread_join.3,v 1.6 1999/08/28 00:03:06 peter Exp $ 33.\" 34.Dd April 4, 1996 35.Dt PTHREAD_JOIN 3 36.Os 37.Sh NAME 38.Nm pthread_join 39.Nd wait for thread termination 40.Sh SYNOPSIS 41.Fd #include <pthread.h> 42.Ft int 43.Fn pthread_join "pthread_t thread" "void **value_ptr" 44.Sh DESCRIPTION 45The 46.Fn pthread_join 47function suspends execution of the calling thread until the target 48.Fa thread 49terminates unless the target 50.Fa thread 51has already terminated. 52.Pp 53On return from a successful 54.Fn pthread_join 55call with a non-NULL 56.Fa value_ptr 57argument, the value passed to 58.Fn pthread_exit 59by the terminating thread is stored in the location referenced by 60.Fa value_ptr . 61When a 62.Fn pthread_join 63returns successfully, the target thread has been terminated. The results 64of multiple simultaneous calls to 65.Fn pthread_join 66specifying the same target thread are undefined. If the thread calling 67.Fn pthread_join 68is cancelled, then the target thread is not detached. 69.Pp 70A thread that has exited but remains unjoined counts against 71[_POSIX_THREAD_THREADS_MAX]. 72.Sh RETURN VALUES 73If successful, the 74.Fn pthread_join 75function will return zero. Otherwise an error number will be returned to 76indicate the error. 77.Sh ERRORS 78.Fn pthread_join 79will fail if: 80.Bl -tag -width Er 81.It Bq Er EINVAL 82The implementation has detected that the value specified by 83.Fa thread 84does not refer to a joinable thread. 85.It Bq Er ESRCH 86No thread could be found corresponding to that specified by the given 87thread ID, 88.Fa thread . 89.It Bq Er EDEADLK 90A deadlock was detected or the value of 91.Fa thread 92specifies the calling thread. 93.El 94.Sh SEE ALSO 95.Xr wait 2 , 96.Xr pthread_create 3 97.Sh STANDARDS 98.Fn pthread_join 99conforms to ISO/IEC 9945-1 ANSI/IEEE 100.Pq Dq Tn POSIX 101Std 1003.1 Second Edition 1996-07-12. 102