summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_setlibrarypath.rst
blob: 52336e62d9dc3c7d2e767cd23d0e67de8d581174 (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
PR_SetLibraryPath
=================

Registers a default library pathname with a runtime.


Syntax
------

.. code::

   #include <prlink.h>

   PRStatus PR_SetLibraryPath(const char *path);


Parameters
~~~~~~~~~~

The function has this parameter:

``path``
   A pointer to a character array that contains the directory path that
   the application should use as a default. The syntax of the pathname
   is not defined, nor whether that pathname should be absolute or
   relative.


Returns
~~~~~~~

The function returns one of the following values:

-  If successful, ``PR_SUCCESS``.
-  If unsuccessful, ``PR_FAILURE``. This may indicate that the function
   cannot allocate sufficient storage to make a copy of the path string


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

This function registers a default library pathname with the runtime.
This allows an environment to express policy decisions globally and
lazily, rather than hardcoding and distributing the decisions throughout
the code.