FileLib Xojo and Real Studio plugin

GetDesktopComment Method

Reads the file comment from a folderitem.

GetDesktopComment(
   f as FolderItem) as String

Parameters

f
The file or folder.

Returns

String

Remarks

Linux and Windows systems have no concept for file comments so this function is not supported on those platforms. It is perfectly valid to call this function on the unsupported platforms but it will only return a empty string there.

MacOS X has no API to read or write OS X comments, so we send a AppleEvent to the operating system to ask the operating system to do it. Because of this fact then reading and writing file comments is slower on MacOS X.

Supported Platforms:

  • MacOS X Carbon
  • MacOS X Cocoa

    Unsupported Platforms:

  • Win32 - Windows
  • Linux x86

    See Also

    GlobalMethods Global