  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The DeleteFolder function removes a folder from the directory tree.
Syntax/Parameters
Syntax
int = DeleteFolder ( string path );
Parameters
path
A string containing the path of the folder to be removed. This path must specify an empty directory and must be qualified. This parameter supports UTF encoding for filenames with Unicode characters.
Return Value
Returns an int as ERROR_NONE on success or a formatted error code on failure. Use the GetLastError function to retrieve error information. Error codes match Windows system error codes (for a list, see the Appendix A — Legato SDK Standard Definitions or MSDN).
Remarks
The last folder in the path parameter is deleted. If there are any entries in the directory, the DeleteFolder function will fail.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.