Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5   7.6    Statistic  

Files.SetComment

Sets the file comment.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
Files 6.2 Yes No Yes, macOS only No No

MBS( "Files.SetComment"; Path; Comment )

Parameters

Parameter Description Example value
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.

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


Files.RevealFile   -   Files.SetCreationDate

Feedback: Report problem or ask question.




Links
MBS FileMaker Plugins