blob: c347d94e5e080d242f8ae468bc0158cf1a61d84d (
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
PR_CreateFileMap
================
Creates a file mapping object.
Syntax
------
.. code::
#include <prio.h>
PRFileMap* PR_CreateFileMap(
PRFileDesc *fd,
PRInt64 size,
PRFileMapProtect prot);
Parameters
~~~~~~~~~~
The function has the following parameters:
``fd``
A pointer to a :ref:`PRFileDesc` object representing the file that is to
be mapped to memory.
``size``
Size of the file specified by ``fd``.
``prot``
Protection option for read and write accesses of a file mapping. This
parameter consists of one of the following options:
- :ref:`PR_PROT_READONLY`. Read-only access.
- :ref:`PR_PROT_READWRITE`. Readable, and write is shared.
- :ref:`PR_PROT_WRITECOPY`. Readable, and write is private
(copy-on-write).
Returns
~~~~~~~
- If successful, a file mapping of type :ref:`PRFileMap`.
- If unsuccessful, ``NULL``.
Description
-----------
The ``PRFileMapProtect`` enumeration used in the ``prot`` parameter is
defined as follows:
.. code::
typedef enum PRFileMapProtect {
PR_PROT_READONLY,
PR_PROT_READWRITE,
PR_PROT_WRITECOPY
} PRFileMapProtect;
:ref:`PR_CreateFileMap` only prepares for the mapping a file to memory. The
returned file-mapping object must be passed to :ref:`PR_MemMap` to actually
map a section of the file to memory.
The file-mapping object should be closed with a :ref:`PR_CloseFileMap` call
when it is no longer needed.
|
