pr_closedir.rst (809B)
1 PR_CloseDir 2 =========== 3 4 Closes the specified directory. 5 6 7 Syntax 8 ------ 9 10 .. code:: 11 12 #include <prio.h> 13 14 PRStatus PR_CloseDir(PRDir *dir); 15 16 17 Parameter 18 ~~~~~~~~~ 19 20 The function has the following parameter: 21 22 ``dir`` 23 A pointer to a :ref:`PRDir` structure representing the directory to be 24 closed. 25 26 27 Returns 28 ~~~~~~~ 29 30 - If successful, ``PR_SUCCESS``. 31 - If unsuccessful, ``PR_FAILURE``. The reason for the failure can be 32 retrieved via :ref:`PR_GetError`. 33 34 35 Description 36 ----------- 37 38 When a :ref:`PRDir` object is no longer needed, it must be closed and freed 39 with a call to :ref:`PR_CloseDir` call. Note that after a :ref:`PR_CloseDir` 40 call, any ``PRDirEntry`` object returned by a previous :ref:`PR_ReadDir` 41 call on the same :ref:`PRDir` object becomes invalid. 42 43 44 See Also 45 -------- 46 47 :ref:`PR_OpenDir`