Apps     Components     Interfaces     All Files     Source Tree     source: tos.lib.FS.FileRename.nc

Interface: FileRename

Rename a file

Components providing this interface:
tos.lib.FS.Matchbox
tos.lib.FS.Rename

Components requiring this interface:
tos.lib.FS.Remote

Commands

Events

Commands - Details

rename

result_t rename(const char *oldName, const char *newName)

Rename a file. If a file called newName exists, it is deleted.

Parameters:

oldName - Name of file to rename. Must not be stack allocated.

newName - New name of file. Must not be stack allocated.

Returns: SUCCESS: attempt proceeds, renamed will be signaled
FAIL: filesystem is busy or newName is ""