documentation.help

FSrmdir Function

From Microchip MDD File System Interface

previous page next page
MDDFS Interface Library Help
Contents | Index | Home
Previous | Up | Next
FSrmdir Function
C
int FSrmdir(
    char * path, 
    unsigned char rmsubdirs
);
Description

The FSrmdir function passes a RAM pointer to the path to the rmdirhelper function.

Preconditions

None

Parameters
Parameters 
Description 
path 
The path of the directory to remove 
rmsubdirs 
  • TRUE - All sub-dirs and files in the target dir will be removed
  • FALSE - FSrmdir will not remove non-empty directories

 

Return Values
Return Values 
Description 
0 
The specified directory was deleted successfully 
EOF 
The specified directory could not be deleted 
Side Effects

The FSerrno variable will be changed.

Remarks

None.

APIs > File Manipulation Layer (FSIO) > Public Members > FSrmdir Function
Microchip MDD File System Interface 1.2.0 - [Aug 18, 2008]
Copyright © 2008 Microchip Technology, Inc.  All rights reserved.
Contents | Index | Home
previous page start next page