summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_getopenfileinfo.rst
blob: 7722606141a3767cfc08e8117fffc030befb0499 (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
PR_GetOpenFileInfo
==================

Gets an open file's information. File size is expressed as a 32-bit
integer.


Syntax
------

.. code::

   #include <prio.h>

   PRStatus PR_GetOpenFileInfo(
     PRFileDesc *fd,
     PRFileInfo *info);


Parameters
~~~~~~~~~~

The function has the following parameters:

``fd``
   A pointer to a :ref:`PRFileDesc` object for an open file.
``info``
   A pointer to a :ref:`PRFileInfo` object. On output, information about
   the given file is written into the file information object.


Returns
~~~~~~~

The function returns one of the following values:

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


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

:ref:`PR_GetOpenFileInfo` obtains the file type (normal file, directory, or
other), file size (as a 32-bit integer), and the file creation and
modification times of the open file represented by the file descriptor.


See Also
--------

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