blob: a6a5590729f48cfb3fd1778e62205efeaa9e9883 (
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
|
PR_CloseFileMap
===============
Closes a file mapping.
Syntax
------
.. code::
#include <prio.h>
PRStatus PR_CloseFileMap(PRFileMap *fmap);
Parameter
~~~~~~~~~
The function has the following parameter:
``fmap``
The file mapping to be closed.
Returns
~~~~~~~
The function returns one of the following values:
- If the memory region is successfully unmapped, ``PR_SUCCESS``.
- If the memory region is not successfully unmapped, ``PR_FAILURE``.
The error code can be retrieved via :ref:`PR_GetError`.
Description
-----------
When a file mapping created with a call to :ref:`PR_CreateFileMap` is no
longer needed, it should be closed with a call to :ref:`PR_CloseFileMap`.
|