summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/prcalloncetype.rst
blob: 6d306d02223fbb88e239e1e4cfccd614ac6904ac (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
PRCallOnceType
==============

Structure for tracking initialization.


Syntax
------

.. code::

   #include <prinit.h>

   typedef struct PRCallOnceType {
     PRIntn initialized;
     PRInt32 inProgress;
     PRStatus status;
   } PRCallOnceType;


Fields
~~~~~~

The structure has these fields:

``initialized``
   If not zero, the initialization process has been completed.
``inProgress``
   If not zero, the initialization process is currently being executed.
   Calling threads that observe this status block until inProgress is
   zero.
``status``
   An indication of the outcome of the initialization process.


Description
-----------

The client is responsible for initializing the :ref:`PRCallOnceType`
structure to all zeros. This initialization must be accomplished before
any threading issues exist.