summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_setpollableevent.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_setpollableevent.rst')
-rw-r--r--docs/nspr/reference/pr_setpollableevent.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_setpollableevent.rst b/docs/nspr/reference/pr_setpollableevent.rst
new file mode 100644
index 0000000000..e9de4eb19e
--- /dev/null
+++ b/docs/nspr/reference/pr_setpollableevent.rst
@@ -0,0 +1,32 @@
+PR_SetPollableEvent
+===================
+
+Set a pollable event.
+
+
+Syntax
+------
+
+.. code::
+
+ NSPR_API(PRStatus) PR_SetPollableEvent(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`.