wFSrmdir Function

From MDD File System Interface Library

MDDFS Interface Library Help
wFSrmdir Function
C
int wFSrmdir(
    unsigned short int * path, 
    unsigned char rmsubdirs
);
Description

Deletes the directory as per the UTF16 input path (PIC24/PIC32/dsPIC). This function wont delete the current working directory.

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.

Microchip MDD File System Interface 1.4.2 - [Oct 15, 2012]
Copyright © 2012 Microchip Technology, Inc.  All rights reserved.