# FS_DeleteFile

## Syntax

    #include <nitro/fs.h>

    BOOL FS_DeleteFile(const char *path);

## Arguments

path | Path name of the file to be deleted.

## Return Values

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

## Description

Deletes the specified file. The function returns FALSE in the following situations:

- If the target archive does not support the deletion of files
- If the specified file does not exist

## 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.

## See Also

`FS_PERMIT_*
FS_CreateFile FS_RenameFile FS_GetResultCode`

## Revision History

2007/09/18 Initial version.

CONFIDENTIAL