summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_extern.rst
blob: 64d38654b64549f1dfb6a154728be168ff48559e (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
PR_EXTERN
=========

Used to define the prototypes for functions or variables that are to be
exported from a shared library.


Syntax
------

.. code::

   #include <prtypes.h>

   PR_EXTERN(type)prototype


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

:ref:`PR_EXTERN` is used to define externally visible routines and globals.
For syntax details for each platform, see
`prtypes.h <https://dxr.mozilla.org/mozilla-central/source/nsprpub/pr/include/prtypes.h>`__.
The macro includes the proper specifications to declare the target
``extern`` and set up other required linkages.

.. warning::

   **Warning**: Some platforms do not allow the use of the underscore
   character (_) as the first character of an exported symbol.