tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

pr_getfileinfo64.rst (1196B)


      1 PR_GetFileInfo64
      2 ================
      3 
      4 Gets information about a file with a specified pathname. File size is
      5 expressed as a 64-bit integer.
      6 
      7 
      8 Syntax
      9 ------
     10 
     11 .. code::
     12 
     13   #include <prio.h>
     14 
     15   PRStatus PR_GetFileInfo64(
     16     const char *fn,
     17     PRFileInfo64 *info);
     18 
     19 
     20 Parameters
     21 ~~~~~~~~~~
     22 
     23 The function has the following parameters:
     24 
     25 ``fn``
     26   The pathname of the file to get information about.
     27 ``info``
     28   A pointer to a 64-bit file information object (see :ref:`PRFileInfo64`).
     29   On output, :ref:`PR_GetFileInfo64` writes information about the given
     30   file to the file information object.
     31 
     32 
     33 Returns
     34 ~~~~~~~
     35 
     36 One of the following values:
     37 
     38 -  If the file information is successfully obtained, ``PR_SUCCESS``.
     39 -  If the file information is not successfully obtained, ``PR_FAILURE``.
     40 
     41 
     42 Description
     43 -----------
     44 
     45 :ref:`PR_GetFileInfo64` stores information about the file with the
     46 specified pathname in the :ref:`PRFileInfo64` structure pointed to by
     47 ``info``. The file size is returned as an unsigned 64-bit integer.
     48 
     49 
     50 See Also
     51 --------
     52 
     53 For the 32-bit version of this function, see :ref:`PR_GetFileInfo`. To get
     54 equivalent information on a file that's already open, use
     55 :ref:`PR_GetOpenFileInfo64`.