Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Files.IsExcludedFromBackup

Queries file extension visibility state 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.IsExcludedFromBackup"; Path )   More

Parameters

Parameter Description Example
Path The native path to the file or folder to be checked. "/Users/John/Desktop/test.txt"

Result

Returns OK or error.

Description

Queries file extension visibility state of a file or folder.
Value is 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.

This function requires a native path. Use Path.FileMakerPathToNativePath to convert a FileMaker path to a native path if required. If you like to have the user choose the path, you can use FileDialog functions.
For Server be aware that server has limited permissions and may not be able to access all files on a computer.

See also

Release notes

Blog Entries

This function is free to use.

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


Files.IsApplication - Files.IsFileExtensionHidden