summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_exportfilemapasstring.rst
blob: 649a373a34868e6be3bab5efe37d33f644a30082 (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
PR_ExportFileMapAsString
========================

Creates a string identifying a :ref:`PRFileMap`.


Syntax
------

.. code::

   #include <prshma.h>

   NSPR_API( PRStatus )
   PR_ExportFileMapAsString(
     PRFileMap *fm,
     PRSize bufsize,
     char *buf
   );

#. define PR_FILEMAP_STRING_BUFSIZE 128


Parameters
~~~~~~~~~~

The function has the following parameters:

``fm``
   A pointer to the :ref:`PRFileMap` to be represented as a string.
``bufsize``
   sizeof(buf)
``buf``
   A pointer to abuffer of length ``PR_FILEMAP_STRING_BUFSIZE``.


Returns
~~~~~~~

:ref:`PRStatus`


Description
-----------

Creates an identifier, as a string, from a :ref:`PRFileMap` object
previously created with :ref:`PR_OpenAnonFileMap`.