docs/nspr/reference/pr_setpollableevent.rst

   1 PR_SetPollableEvent
   2 ===================
   3
   4 Set a pollable event.
   5
   6
   7 Syntax
   8 ------
   9
  10 .. code::
  11
  12    NSPR_API(PRStatus) PR_SetPollableEvent(PRFileDesc *event);
  13
  14
  15 Parameter
  16 ~~~~~~~~~
  17
  18 The function has the following parameter:
  19
  20 ``event``
  21    Pointer to a :ref:`PRFileDesc` structure previously created via a call
  22    to :ref:`PR_NewPollableEvent`.
  23
  24
  25 Returns
  26 ~~~~~~~
  27
  28 The function returns one of the following values:
  29
  30 -  If successful, ``PR_SUCCESS``.
  31 -  If unsuccessful, ``PR_FAILURE``. The reason for the failure can be
  32    retrieved via :ref:`PR_GetError`.