prfilemap.rst (702B)
1 PRFileMap 2 ========= 3 4 Type returned by :ref:`PR_CreateFileMap` and passed to :ref:`PR_MemMap` and 5 :ref:`PR_CloseFileMap`. 6 7 8 Syntax 9 ------ 10 11 .. code:: 12 13 #include <prio.h> 14 15 typedef struct PRFileMap PRFileMap; 16 17 18 Description 19 ----------- 20 21 The opaque structure :ref:`PRFileMap` represents a memory-mapped file 22 object. Before actually mapping a file to memory, you must create a 23 memory-mapped file object by calling :ref:`PR_CreateFileMap`, which returns 24 a pointer to :ref:`PRFileMap`. Then sections of the file can be mapped into 25 memory by passing the :ref:`PRFileMap` pointer to :ref:`PR_MemMap`. The 26 memory-mapped file object is closed by passing the :ref:`PRFileMap` pointer 27 to :ref:`PR_CloseFileMap`.