summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_seterror.rst
blob: 87d256139a2a30c9d13882d3afc9f8749f5d8729 (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
34
35
PR_SetError
===========

Sets error information within a thread context.


Syntax
------

.. code::

   #include <prerror.h>

   void PR_SetError(PRErrorCode errorCode, PRInt32 oserr)


Parameters
~~~~~~~~~~

The function has these parameters:

``errorCode``
   The NSPR (platform-independent) translation of the error.

``oserr``
   The platform-specific error. If there is no appropriate OS error
   number, a zero may be supplied.


Description
-----------

NSPR does not validate the value of the error number or OS error number
being specified. The runtime merely stores the value and returns it when
requested.