pr_setlibrarypath.rst (977B)
1 PR_SetLibraryPath 2 ================= 3 4 Registers a default library pathname with a runtime. 5 6 7 Syntax 8 ------ 9 10 .. code:: 11 12 #include <prlink.h> 13 14 PRStatus PR_SetLibraryPath(const char *path); 15 16 17 Parameters 18 ~~~~~~~~~~ 19 20 The function has this parameter: 21 22 ``path`` 23 A pointer to a character array that contains the directory path that 24 the application should use as a default. The syntax of the pathname 25 is not defined, nor whether that pathname should be absolute or 26 relative. 27 28 29 Returns 30 ~~~~~~~ 31 32 The function returns one of the following values: 33 34 - If successful, ``PR_SUCCESS``. 35 - If unsuccessful, ``PR_FAILURE``. This may indicate that the function 36 cannot allocate sufficient storage to make a copy of the path string 37 38 39 Description 40 ----------- 41 42 This function registers a default library pathname with the runtime. 43 This allows an environment to express policy decisions globally and 44 lazily, rather than hardcoding and distributing the decisions throughout 45 the code.