Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 11.4   11.5   12.0   12.1   12.2   12.3   12.4   12.5   13.0   13.1    Statistic    FMM    Blog  


Sets file backup exclusion of a file or folder.

Component Version macOS Windows Linux Server iOS SDK
Files 12.0 ✅ Yes ❌ No ❌ No ✅ Yes, on macOS ❌ No
MBS( "Files.SetExcludedFromBackup"; Path; Value )   More


Parameter Description Example
Path The native path to the file or folder to be checked. "/Users/John/Desktop/test.txt"
Value The new state.
Pass 1 to hide file or 0 to unhide file.


Returns OK or error.


Sets file backup exclusion of a file or folder.
Set to 1 if resource should be excluded from backups, 0 otherwise.
This property is only useful for excluding cache and other application support files which are not needed in a backup. Some operations commonly made to user documents will cause this property to be reset to false and so this property should not be used on user documents.

Files in standard temporary folders do not need to be marked for exclusion as those are automatically excluded.

See also

Release notes

Blog Entries

This function does not need a paid license.

Created 13th January 2022, last changed 23th May 2022

Files.SetCreationDate - Files.SetFileExtensionHidden

💬 Ask a question or report a problem

Start Chat