summaryrefslogtreecommitdiff
path: root/linuxthreads/man/pthread_exit.man
blob: 54751e9d05232111a856f94350d826345517dcb6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
.TH PTHREAD_EXIT 3 LinuxThreads

.SH NAME
pthread_exit \- terminate the calling thread

.SH SYNOPSIS
#include <pthread.h>

void pthread_exit(void *retval);

.SH DESCRIPTION
!pthread_exit! terminates the execution of the calling thread.
All cleanup handlers that have been set for the calling thread with
!pthread_cleanup_push!(3) are executed in reverse order (the most
recently pushed handler is executed first). Finalization functions for
thread-specific data are then called for all keys that have non-!NULL!
values associated with them in the calling thread (see
!pthread_key_create!(3)). Finally, execution of the calling thread is
stopped.

The |retval| argument is the return value of the thread. It can be
consulted from another thread using !pthread_join!(3).

.SH "RETURN VALUE"
The !pthread_exit! function never returns.

.SH AUTHOR
Xavier Leroy <Xavier.Leroy@inria.fr>

.SH "SEE ALSO"
!pthread_create!(3),
!pthread_join!(3).