summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_waitforpollableevent.rst
blob: 5996dd4872e071cb27d098103754e5fa6426a373 (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
PR_WaitForPollableEvent
=======================

Blocks the calling thread until the pollable event is set, and then
atomically unsetting the event before returning.


Syntax
------

.. code::

   NSPR_API(PRStatus) PR_WaitForPollableEvent(PRFileDesc *event);


Parameter
~~~~~~~~~

The function has the following parameter:

``event``
   Pointer to a :ref:`PRFileDesc` structure previously created via a call
   to :ref:`PR_NewPollableEvent`.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, ``PR_SUCCESS``.
-  If unsuccessful, ``PR_FAILURE``. The reason for the failure can be
   retrieved via :ref:`PR_GetError`.