docs/nspr/reference/pr_geterrortext.rst

   1 PR_GetErrorText
   2 ===============
   3
   4 Copies the current thread's current error text without altering the text
   5 as stored in the thread's context.
   6
   7
   8 Syntax
   9 ------
  10
  11 .. code::
  12
  13    #include <prerror.h>
  14
  15    PRInt32 PR_GetErrorText(char *text);
  16
  17
  18 Parameters
  19 ~~~~~~~~~~
  20
  21 The function has one parameter:
  22
  23 ``text``
  24    On output, the array pointed to contains the thread's current error
  25    text.
  26
  27
  28 Returns
  29 -------
  30
  31 The actual number of bytes copied. If the result is zero, ``text`` is
  32 unaffected.