summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_processattrsetinheritablefilemap.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_processattrsetinheritablefilemap.rst')
-rw-r--r--docs/nspr/reference/pr_processattrsetinheritablefilemap.rst53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_processattrsetinheritablefilemap.rst b/docs/nspr/reference/pr_processattrsetinheritablefilemap.rst
new file mode 100644
index 0000000000..c89f2740eb
--- /dev/null
+++ b/docs/nspr/reference/pr_processattrsetinheritablefilemap.rst
@@ -0,0 +1,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.