pr_closefilemap.rst (700B)
1 PR_CloseFileMap 2 =============== 3 4 Closes a file mapping. 5 6 7 Syntax 8 ------ 9 10 .. code:: 11 12 #include <prio.h> 13 14 PRStatus PR_CloseFileMap(PRFileMap *fmap); 15 16 17 Parameter 18 ~~~~~~~~~ 19 20 The function has the following parameter: 21 22 ``fmap`` 23 The file mapping to be closed. 24 25 26 Returns 27 ~~~~~~~ 28 29 The function returns one of the following values: 30 31 - If the memory region is successfully unmapped, ``PR_SUCCESS``. 32 - If the memory region is not successfully unmapped, ``PR_FAILURE``. 33 The error code can be retrieved via :ref:`PR_GetError`. 34 35 36 Description 37 ----------- 38 39 When a file mapping created with a call to :ref:`PR_CreateFileMap` is no 40 longer needed, it should be closed with a call to :ref:`PR_CloseFileMap`.