summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_sync.rst
blob: 5d6df28689f41854267e726a26b02aa7f9ab5287 (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
PR_Sync
=======

Synchronizes any buffered data for a file descriptor to its backing
device (disk).


Syntax
------

.. code::

   #include <prio.h>

   PRStatus PR_Sync(PRFileDesc *fd);


Parameter
~~~~~~~~~

The function has the following parameter:

``fd``
   Pointer to a :ref:`PRFileDesc` object representing a file.


Returns
~~~~~~~

The function returns one of the following values:

-  On successful completion, ``PR_SUCCESS``.
-  If the function fails, ``PR_FAILURE``.


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

:ref:`PR_Sync` writes all the in-memory buffered data of the specified file
to the disk.