summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getinheritedfilemap.rst
blob: 62d93058f4d3a6f6382ef7b11d05e2e81bf7b45c (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
PR_GetInheritedFileMap
======================

Imports a :ref:`PRFileMap` previously exported by my parent process via
``PR_CreateProcess``.


Syntax
------

.. code::

   #include <prshma.h>

   NSPR_API( PRFileMap *)
   PR_GetInheritedFileMap(
     const char *shmname
   );


Parameter
~~~~~~~~~

The function has the following parameter:

``shmname``
   The name provided to :ref:`PR_ProcessAttrSetInheritableFileMap`.


Returns
~~~~~~~

Pointer to :ref:`PRFileMap` or ``NULL`` on error.


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

:ref:`PR_GetInheritedFileMap` retrieves a PRFileMap object exported from
its parent process via ``PR_CreateProcess``.

.. note::

   **Note:** This function is not implemented.