  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The RecycleFile function places the specified file or folder and its contents in the recycle bin if possible. If the file or folder cannot be recycled, it is deleted.
Syntax/Parameters
Syntax
int = RecycleFile ( string target );
Parameters
string
A string containing a fully qualified path and filename. 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. Note that the underlying Windows error code does not use the standard error code but rather returns Windows shell error codes. See MSDN SHFileOperation for additional details.
Remarks
The RecycleFile function will behave like the DeleteFile function if the volume on which the file specified by the name parameter is located does not support recycling. This function only works on certain Windows file systems; using it on a file located on the VFC will delete the file.
If the item is too large for the recycle bin, it will be deleted.
The RecycleFile will also allow folders and subfolders to be deleted.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Page revised 2024-12-13
| 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.