summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_processattrsetinheritablefilemap.rst
blob: c89f2740eb8725056839e811faf1c11a3bf96a2a (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
PR_ProcessAttrSetInheritableFileMap
===================================

Prepare filemap for export to my children processes via
``PR_CreateProcess``.


Syntax
------

.. code::

   #include <prshma.h>

   NSPR_API(PRStatus)
   PR_ProcessAttrSetInheritableFileMap(
     PRProcessAttr   *attr,
     PRFileMap       *fm,
     const char      *shmname
   );


Parameters
~~~~~~~~~~

The function has the following parameters:

``attr``
   Pointer to a PRProcessAttr structure used to pass data to
   PR_CreateProcess.
``fm``
   Pointer to a PRFileMap structure to be passed to the child process.
``shmname``
   Pointer to the name for the PRFileMap; used by child.


Returns
~~~~~~~

:ref:`PRStatus`


Description
~~~~~~~~~~~

:ref:`PR_ProcessAttrSetInheritableFileMap` connects the :ref:`PRFileMap` to
:ref:`PRProcessAttr` with ``shmname``. A subsequent call to
``PR_CreateProcess`` makes the :ref:`PRFileMap` importable by the child
process.

.. note::

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