File: pr_memmap.rst

package info (click to toggle)
thunderbird 1%3A115.16.0esr-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,476,252 kB
  • sloc: cpp: 6,972,150; javascript: 5,209,211; ansic: 3,507,222; python: 1,137,609; asm: 432,531; xml: 205,149; java: 175,761; sh: 116,485; makefile: 22,152; perl: 13,971; objc: 12,561; yacc: 4,583; pascal: 2,840; lex: 1,720; ruby: 1,075; exp: 762; sql: 666; awk: 580; php: 436; lisp: 430; sed: 70; csh: 10
file content (50 lines) | stat: -rw-r--r-- 969 bytes parent folder | download | duplicates (18) 
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
 
PR_MemMap
=========

Maps a section of a file to memory.


Syntax
------

.. code::

   #include <prio.h>

   void* PR_MemMap(
     PRFileMap *fmap,
     PRInt64 offset,
     PRUint32 len);


Parameters
~~~~~~~~~~

The function has the following parameters:

``fmap``
   A pointer to the file-mapping object representing the file to be
   memory-mapped.
``offset``
   The starting offset of the section of file to be mapped. The offset
   must be aligned to whole pages.
``len``
   Length of the section of the file to be mapped.


Returns
~~~~~~~

The starting address of the memory region to which the section of file
is mapped. Returns ``NULL`` on error.


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

:ref:`PR_MemMap` maps a section of the file represented by the file mapping
``fmap`` to memory. The section of the file starts at ``offset`` and has
the length ``len``.

When the file-mapping memory region is no longer needed, it should be
unmapped with a call to :ref:`PR_MemUnmap`.