FSrename Function

MDD File System Interface Library

previous page next page
MDDFS Interface Library Help
Contents | Index | Home
Previous | Up | Next
FSrename Function
C
int FSrename(
    const char * fileName, 
    FSFILE * fo
);
Description

Renames the Ascii name of the file or directory on PIC24/PIC32/dsPIC devices. First, it will search through the current working directory to ensure the specified new filename is not already in use. If it isn't, the new filename will be written to the file entry of the file pointed to by 'fo.'

Preconditions

File opened.

Parameters
Parameters 
Description 
fileName 
The new name of the file 
fo 
The file to rename 
Return Values
Return Values 
Description 
0 
File was renamed successfully 
EOF 
File was not renamed 
Side Effects

The FSerrno variable will be changed.

Remarks

None

APIs > File Manipulation Layer (FSIO) > Functions > FSrename Function
Microchip MDD File System Interface 1.4.2 - [Oct 15, 2012]
Copyright © 2012 Microchip Technology, Inc.  All rights reserved.
Contents | Index | Home
previous page start next page