summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_importfilemapfromstring.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_importfilemapfromstring.rst')
-rw-r--r--docs/nspr/reference/pr_importfilemapfromstring.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_importfilemapfromstring.rst b/docs/nspr/reference/pr_importfilemapfromstring.rst
new file mode 100644
index 0000000000..bc9694d557
--- /dev/null
+++ b/docs/nspr/reference/pr_importfilemapfromstring.rst
@@ -0,0 +1,39 @@
+PR_ImportFileMapFromString
+==========================
+
+Creates a :ref:`PRFileMap` from an identifying string.
+
+
+Syntax
+~~~~~~
+
+.. code::
+
+ #include <prshma.h>
+
+ NSPR_API( PRFileMap * )
+ PR_ImportFileMapFromString(
+ const char *fmstring
+ );
+
+
+Parameter
+~~~~~~~~~
+
+The function has the following parameter:
+
+fmstring
+ A pointer to string created by :ref:`PR_ExportFileMapAsString`.
+
+
+Returns
+~~~~~~~
+
+:ref:`PRFileMap` pointer or ``NULL`` on error.
+
+
+Description
+-----------
+
+:ref:`PR_ImportFileMapFromString` creates a :ref:`PRFileMap` object from a
+string previously created by :ref:`PR_ExportFileMapAsString`.