docs/nspr/reference/pr_processattrsetinheritablefilemap.rst

   1 PR_ProcessAttrSetInheritableFileMap
   2 ===================================
   3
   4 Prepare filemap for export to my children processes via
   5 ``PR_CreateProcess``.
   6
   7
   8 Syntax
   9 ------
  10
  11 .. code::
  12
  13    #include <prshma.h>
  14
  15    NSPR_API(PRStatus)
  16    PR_ProcessAttrSetInheritableFileMap(
  17      PRProcessAttr   *attr,
  18      PRFileMap       *fm,
  19      const char      *shmname
  20    );
  21
  22
  23 Parameters
  24 ~~~~~~~~~~
  25
  26 The function has the following parameters:
  27
  28 ``attr``
  29    Pointer to a PRProcessAttr structure used to pass data to
  30    PR_CreateProcess.
  31 ``fm``
  32    Pointer to a PRFileMap structure to be passed to the child process.
  33 ``shmname``
  34    Pointer to the name for the PRFileMap; used by child.
  35
  36
  37 Returns
  38 ~~~~~~~
  39
  40 :ref:`PRStatus`
  41
  42
  43 Description
  44 ~~~~~~~~~~~
  45
  46 :ref:`PR_ProcessAttrSetInheritableFileMap` connects the :ref:`PRFileMap` to
  47 :ref:`PRProcessAttr` with ``shmname``. A subsequent call to
  48 ``PR_CreateProcess`` makes the :ref:`PRFileMap` importable by the child
  49 process.
  50
  51 .. note::
  52
  53    **Note:** This function is not implemented.