summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getlibrarypath.rst
blob: c604edc9cd4c9b7b6d8162166286f01943d77704 (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
PR_GetLibraryPath
=================

Retrieves the current default library path.


Syntax
------

.. code::

   #include <prlink.h>

   char* PR_GetLibraryPath(void);


Parameters
~~~~~~~~~~

The function has no parameters.


Returns
~~~~~~~

A copy of the default library pathname string. In case of error, returns
NULL.


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

This function retrieves the current default library pathname, copies it,
and returns the copy. If sufficient storage cannot be allocated to
contain the copy, the function returns ``NULL``. Storage for the result
is allocated by the runtime and becomes the responsibility of the
caller. When it is no longer used, free it using :ref:`PR_FreeLibraryName`.