summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/prdir.rst
blob: feabd3eafc147216a2c7bbd9e5db886b9b92a09e (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
PRDir
=====

Directory structure used with `Directory I/O
Functions <I_O_Functions#Directory_I.2FO_Functions>`__.


Syntax
------

.. code::

   #include <prio.h>

   typedef struct PRDir PRDir;


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

The opaque structure :ref:`PRDir` represents an open directory in the file
system. The function :ref:`PR_OpenDir` opens a specified directory and
returns a pointer to a :ref:`PRDir` structure, which can be passed to
:ref:`PR_ReadDir` repeatedly to obtain successive entries (files or
subdirectories in the open directory). To close the directory, pass the
:ref:`PRDir` pointer to :ref:`PR_CloseDir`.