summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getfileinfo64.rst
blob: f57217103a03c336f24f7d423c6fefa0dc27b3d2 (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
50
51
52
53
54
55
PR_GetFileInfo64
================

Gets information about a file with a specified pathname. File size is
expressed as a 64-bit integer.


Syntax
------

.. code::

   #include <prio.h>

   PRStatus PR_GetFileInfo64(
     const char *fn,
     PRFileInfo64 *info);


Parameters
~~~~~~~~~~

The function has the following parameters:

``fn``
   The pathname of the file to get information about.
``info``
   A pointer to a 64-bit file information object (see :ref:`PRFileInfo64`).
   On output, :ref:`PR_GetFileInfo64` writes information about the given
   file to the file information object.


Returns
~~~~~~~

One of the following values:

-  If the file information is successfully obtained, ``PR_SUCCESS``.
-  If the file information is not successfully obtained, ``PR_FAILURE``.


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

:ref:`PR_GetFileInfo64` stores information about the file with the
specified pathname in the :ref:`PRFileInfo64` structure pointed to by
``info``. The file size is returned as an unsigned 64-bit integer.


See Also
--------

For the 32-bit version of this function, see :ref:`PR_GetFileInfo`. To get
equivalent information on a file that's already open, use
:ref:`PR_GetOpenFileInfo64`.