summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getoserror.rst
blob: 5068018a6321f2f313799e16d273bc72ac996e54 (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
PR_GetOSError
=============

Returns the current thread's last set OS-specific error code.


Syntax
------

.. code::

   #include <prerror.h>

   PRInt32 PR_GetOSError(void)


Returns
~~~~~~~

The value returned is a 32-bit signed number. Its interpretation is left
to the caller.


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

Used for platform-specific code that requires the underlying OS error.
For portability, clients should not create dependencies on the values of
OS-specific error codes. However, this information is preserved, along
with a platform neutral error code, on a per thread basis. It is most
useful during development.