summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_versioncheck.rst
blob: 5d42827ad313025001ba5fa8dc2fdbe83d14bf6f (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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
PR_VersionCheck
===============

Compares the version of NSPR assumed by the caller (the imported
version) with the version being offered by the runtime (the exported
version).


Syntax
------

.. code::

   #include <prinit.h>

   PRBool PR_VersionCheck(const char *importedVersion);


Parameter
~~~~~~~~~

:ref:`PR_VersionCheck` has one parameter:

``importedVersion``
   The version of the shared library being imported.


Returns
~~~~~~~

The function returns one of the following values:

-  If the version of the shared library is compatible with that expected
   by the caller, ``PR_TRUE``.
-  If the versions are not compatible, ``PR_FALSE``.


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

:ref:`PR_VersionCheck` tests whether the version of the library being
imported (``importedVersion``) is compatible with the running version of
the shared library. This is a string comparison of sorts, though the
details of the comparison will vary over time.


See Also
--------

-  `PR_VERSION <PR_VERSION>`__