blob: 67bb1b26731fc277ad5a656b8ae657a01bc8248a (
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
|
PR_Rename
=========
Renames a file.
Syntax
------
.. code::
#include <prio.h>
PRStatus PR_Rename(
const char *from,
const char *to);
Parameters
~~~~~~~~~~
The function has the following parameters:
``from``
The old name of the file to be renamed.
``to``
The new name of the file.
Returns
~~~~~~~
One of the following values:
- If file is successfully renamed, ``PR_SUCCESS``.
- If file is not successfully renamed, ``PR_FAILURE``.
Description
-----------
:ref:`PR_Rename` renames a file from its old name (``from``) to a new name
(``to``). If a file with the new name already exists, :ref:`PR_Rename`
fails with the error code ``PR_FILE_EXISTS_ERROR``. In this case,
:ref:`PR_Rename` does not overwrite the existing filename.
|
