aboutsummaryrefslogtreecommitdiffstats
path: root/man/man3/pthread_once.3
blob: 84fbc6ef6da6d57774c57844f3f34be4406760d0 (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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.\" Copyright, the authors of the Linux man-pages project
.\"
.\" SPDX-License-Identifier: Linux-man-pages-copyleft
.\"
.TH pthread_once 3 (date) "Linux man-pages (unreleased)"
.
.
.SH NAME
pthread_once
\-
once-only initialization
.
.
.SH SYNOPSIS
.B #include <pthread.h>
.P
.BI "pthread_once_t " once_control " = PTHREAD_ONCE_INIT;"
.P
.BI "int pthread_once(pthread_once_t *" once_control ", typeof(void (void)) *" init_routine ;
.
.
.SH DESCRIPTION
The purpose of
.BR pthread_once ()
is
to ensure that a piece of initialization code is executed at most once.
The
.I once_control
argument points to a static or extern variable
statically initialized to
.BR PTHREAD_ONCE_INIT .
.P
The first time
.BR pthread_once ()
is called
with a given
.I once_control
argument,
it calls
.I init_routine
with no argument
and changes the value of the
.I once_control
variable
to record that initialization has been performed.
Subsequent calls to
.BR pthread_once ()
with the same
.I once_control
argument
do nothing.
.
.
.SH "RETURN VALUE"
.BR pthread_once ()
always returns 0.
.
.
.SH ERRORS
None.