summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_findsymbolandlibrary.rst
blob: 0df683a76c0968cb16269d9c4bdba4a8f192d2bb (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
51
52
53
54
55
56
57
58
59
PR_FindSymbolAndLibrary
=======================

Finds a symbol in one of the currently loaded libraries, and returns
both the symbol and the library in which it was found.


Syntax
------

.. code::

   #include <prlink.h>

   void* PR_FindSymbolAndLibrary (
      const char *name,
      PRLibrary **lib);


Parameters
~~~~~~~~~~

The function has these parameters:

``name``
   The textual representation of the symbol to locate.
``lib``
   A reference to a location at which the runtime will store the library
   in which the symbol was discovered. This location must be
   pre-allocated by the caller.


Returns
~~~~~~~

If successful, returns a non-``NULL`` pointer to the found symbol, and
stores a pointer to the library in which it was found at the location
pointed to by lib.

If the symbol could not be found, returns ``NULL``.


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

This function finds the specified symbol in one of the currently loaded
libraries. It returns the address of the symbol. Upon return, the
location pointed to by the parameter lib contains a pointer to the
library that contains that symbol. The location must be pre-allocated by
the caller.

The function returns ``NULL`` if no such function can be found. The
order in which the known libraries are searched in not specified. This
function is equivalent to calling first :ref:`PR_LoadLibrary`, then
:ref:`PR_FindSymbol`.

The identity returned from this function must be the target of a
:ref:`PR_UnloadLibrary` in order to return the runtime to its original
state.