summary refs log tree commit diff
path: root/linuxthreads/man/pthread_create.man
blob: a94004767a66f23f2d32bc0fbf80f78c02f55290 (plain) (blame)
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
.TH PTHREAD_CREATE 3 LinuxThreads

.SH NAME
pthread_create \- create a new thread

.SH SYNOPSIS
#include <pthread.h>

int pthread_create(pthread_t * thread, pthread_attr_t * attr, void * (*start_routine)(void *), void * arg);

.SH DESCRIPTION
!pthread_create! creates a new thread of control that executes
concurrently with the calling thread. The new thread applies the
function |start_routine| passing it |arg| as first argument. The new
thread terminates either explicitly, by calling !pthread_exit!(3),
or implicitly, by returning from the |start_routine| function. The
latter case is equivalent to calling !pthread_exit!(3) with the result
returned by |start_routine| as exit code.

The |attr| argument specifies thread attributes to be applied to the
new thread. See !pthread_attr_init!(3) for a complete list of thread
attributes. The |attr| argument can also be !NULL!, in which case
default attributes are used: the created thread is joinable (not
detached) and has default (non real-time) scheduling policy.

.SH "RETURN VALUE"
On success, the identifier of the newly created thread is stored in
the location pointed by the |thread| argument, and a 0 is returned. On
error, a non-zero error code is returned.

.SH ERRORS
.TP
!EAGAIN!
not enough system resources to create a process for the new thread.
.TP
!EAGAIN!
more than !PTHREAD_THREADS_MAX! threads are already active.

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

.SH "SEE ALSO"
!pthread_exit!(3),
!pthread_join!(3),
!pthread_detach!(3),
!pthread_attr_init!(3).