summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/prfileinfo.rst
blob: 2fe487ac2fc9148f2b967136059c534b22793289 (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
41
42
43
44
45
46
47
48
49
PRFileInfo
==========

File information structure used with :ref:`PR_GetFileInfo` and
:ref:`PR_GetOpenFileInfo`.


Syntax
~~~~~~

.. code::

   #include <prio.h>

   struct PRFileInfo {
      PRFileType type;
      PRUint32 size;
      PRTime creationTime;
      PRTime modifyTime;
   };

   typedef struct PRFileInfo PRFileInfo;




Fields
~~~~~~

The structure has the following fields:

``type``
   Type of file. See :ref:`PRFileType`.
``size``
   Size, in bytes, of file's contents.
``creationTime``
   Creation time per definition of :ref:`PRTime`. See
   `prtime.h <https://dxr.mozilla.org/mozilla-central/source/nsprpub/pr/include/prtime.h>`__.
``modifyTime``
   Last modification time per definition of :ref:`PRTime`. See
   `prtime.h <https://dxr.mozilla.org/mozilla-central/source/nsprpub/pr/include/prtime.h>`__.


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

The :ref:`PRFileInfo` structure provides information about a file, a
directory, or some other kind of file system object, as specified by the
``type`` field.