File: pr_rename.rst

package info (click to toggle)
thunderbird 1%3A115.16.0esr-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,476,252 kB
  • sloc: cpp: 6,972,150; javascript: 5,209,211; ansic: 3,507,222; python: 1,137,609; asm: 432,531; xml: 205,149; java: 175,761; sh: 116,485; makefile: 22,152; perl: 13,971; objc: 12,561; yacc: 4,583; pascal: 2,840; lex: 1,720; ruby: 1,075; exp: 762; sql: 666; awk: 580; php: 436; lisp: 430; sed: 70; csh: 10
file content (45 lines) | stat: -rw-r--r-- 767 bytes parent folder | download | duplicates (18) 
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.