FS_RenameFile

Syntax


#include <nitro/fs.h>

BOOL FS_RenameFile(const char *src, const char *dst);

Arguments

src	Path name of the file before the change.
dst	Path name of the file after the change.

Return Values

Returns TRUE if the file name was changed properly; returns FALSE otherwise. In case of failure, the error details can be obtained using FS_GetArchiveResultCode().

Description

Renames the specified file. This is the same as moving a file. The function returns FALSE in the following situations:

If the target archive does not support renaming files
If the file to be renamed does not exist
If a file with the same name as the requested new name already exists

Note

This function cannot be called from the interrupt handler (IRQ mode). Also note that in some cases processing may not end if interrupts are left prohibited.

Revision History

2007/09/18 Initial version.

CONFIDENTIAL