summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_geterrortext.rst
blob: e8a0508b8af24ef8ab34c78913c62eaee4033f4c (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
PR_GetErrorText
===============

Copies the current thread's current error text without altering the text
as stored in the thread's context.


Syntax
------

.. code::

   #include <prerror.h>

   PRInt32 PR_GetErrorText(char *text);


Parameters
~~~~~~~~~~

The function has one parameter:

``text``
   On output, the array pointed to contains the thread's current error
   text.


Returns
-------

The actual number of bytes copied. If the result is zero, ``text`` is
unaffected.