| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
Files.SetComment
Sets the file comment.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| Files | 6.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes, on macOS | ❌ No |
MBS( "Files.SetComment"; Path; Comment ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| Path | The native path to the file. | "/Users/John/Desktop/test.txt" |
| Comment | The new comment text. | "Hello World" |
Result
Returns OK or error.
Description
Sets the file comment.The comment text is used by Spotlight when searching, so you can place useful information there.
Use Apple Events internally and may fail if those are not permitted. See Automation entry in System Preferences, Privacy section.
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.
Examples
Set comment:
MBS( "Files.SetComment"; "/Users/cs/Desktop/Wifi.rtf"; "Hello World")
See also
Blog Entries
This function checks for a license.
Created 25th April 2016, last changed 22nd January 2021
