summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_importfilemapfromstring.rst
blob: bc9694d557e27b0103af270f17facb0ca044f836 (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
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`.