File: prfilemap.rst

package info (click to toggle)
firefox 148.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,719,544 kB
  • sloc: cpp: 7,618,291; javascript: 6,701,749; ansic: 3,781,787; python: 1,418,389; xml: 638,647; asm: 438,962; java: 186,285; sh: 62,894; makefile: 19,011; objc: 13,092; perl: 12,763; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (27 lines) | stat: -rw-r--r-- 702 bytes parent folder | download | duplicates (16) 
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
 
PRFileMap
=========

Type returned by :ref:`PR_CreateFileMap` and passed to :ref:`PR_MemMap` and
:ref:`PR_CloseFileMap`.


Syntax
------

.. code::

   #include <prio.h>

   typedef struct PRFileMap PRFileMap;


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

The opaque structure :ref:`PRFileMap` represents a memory-mapped file
object. Before actually mapping a file to memory, you must create a
memory-mapped file object by calling :ref:`PR_CreateFileMap`, which returns
a pointer to :ref:`PRFileMap`. Then sections of the file can be mapped into
memory by passing the :ref:`PRFileMap` pointer to :ref:`PR_MemMap`. The
memory-mapped file object is closed by passing the :ref:`PRFileMap` pointer
to :ref:`PR_CloseFileMap`.