# FS_DeleteDirectory

## Syntax

    #include <nitro/fs.h>

    BOOL FS_DeleteDirectory(const char *path);

## Arguments

`path` | Path name of the directory to delete.

## Return Values

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

## Description

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

- If the target archive does not support the deletion of directories
- If the specified directory does not exist
- If the specified directory is not empty

## 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_CreateDirectory
FS_RenameDirectory
FS_GetResultCode`

## Revision History

2009/02/05 Added empty-directory error.
2007/09/18 Initial version.

CONFIDENTIAL