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.\" $FreeBSD$ 32.\" 33.Dd April 4, 1996 34.Dt PTHREAD_JOIN 3 35.Os BSD 4 36.Sh NAME 37.Nm pthread_join 38.Nd wait for thread termination 39.Sh SYNOPSIS 40.Fd #include <pthread.h> 41.Ft int 42.Fn pthread_join "pthread_t thread" "void **value_ptr" 43.Sh DESCRIPTION 44The 45.Fn pthread_join 46function suspends execution of the calling thread until the target 47.Fa thread 48terminates unless the target 49.Fa thread 50has already terminated. 51.Pp 52On return from a successful 53.Fn pthread_join 54call with a non-NULL 55.Fa value_ptr 56argument, the value passed to 57.Fn pthread_exit 58by the terminating thread is stored in the location referenced by 59.Fa value_ptr . 60When a 61.Fn pthread_join 62returns successfully, the target thread has been terminated. The results 63of multiple simultaneous calls to 64.Fn pthread_join 65specifying the same target thread are undefined. If the thread calling 66.Fn pthread_join 67is cancelled, then the target thread is not detached. 68.Pp 69A thread that has exited but remains unjoined counts against 70[_POSIX_THREAD_THREADS_MAX]. 71.Pp 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.Pp 95.Sh SEE ALSO 96.Xr wait 2 , 97.Xr pthread_create 3 98.Sh STANDARDS 99.Fn pthread_join 100conforms to ISO/IEC 9945-1 ANSI/IEEE 101.Pq Dq Tn POSIX 102Std 1003.1 Second Edition 1996-07-12. 103