Platforms to show: All Mac Windows Linux Cross-Platform

The module ExtendedAttributesMBS

module ExtendedAttributesMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
module Files MBS MacOSX Plugin 12.5 ✅ Yes ❌ No ✅ Yes ✅ Yes All
The module for working with extended attributes.
Example
dim f as FolderItem = SpecialFolder.Desktop.Child("test.rtf")

// keys starting with "com.apple.metadata:" are indexed by Spotlight
call ExtendedAttributesMBS.SetAttribute(f, "com.apple.metadata:test", "testvalue")

Linux support added for plugin version 16.4.
For Windows, please use LargeBinaryStreamMBS class to read/write streams.

  • method Available as boolean
  • method GetAttribute(path as folderitem, name as string, options as Integer = 0) as Variant
  • method GetAttribute(path as string, name as string, options as Integer = 0) as Variant
  • method GetRawAttribute(path as folderitem, name as string, options as Integer = 0) as memoryblock
  • method GetRawAttribute(path as string, name as string, options as Integer = 0) as memoryblock
  • method LastError as Integer
  • method LastErrorMessage as string
  • method ListAttributes(path as folderitem, Options as Integer = 0) as string()
  • method ListAttributes(path as string, Options as Integer = 0) as string()
  • method RemoveAttribute(path as folderitem, name as string, options as Integer = 0) as boolean
  • method RemoveAttribute(path as string, name as string, options as Integer = 0) as boolean
  • method SetAttribute(path as folderitem, name as string, data as Variant, options as Integer = 0) as boolean
  • method SetAttribute(path as string, name as string, data as Variant, options as Integer = 0) as boolean
  • method SetRawAttribute(path as folderitem, name as string, data as memoryblock, options as Integer = 0) as boolean
  • method SetRawAttribute(path as string, name as string, data as memoryblock, options as Integer = 0) as boolean
  • 9 constants

Constants

Constant Value Description
kAttributeNameFinderComment "com.apple.metadata:kMDItemFinderComment" The attribute name for the Finder Comment.
kAttributeNameFinderInfo "com.apple.FinderInfo" The attribute name for the Finder Info.
kAttributeNameResourceFork "com.apple.ResourceFork" The attribute name for the resource fork.

Flags

Constant Value Description
kCreate 2 Fail if the named attribute already exists.
kNoDefault 16
kNoFollow 1 Do not follow symbolic links. ListAttributes normally lists attributes of the target of path if it is a symbolic link. With this option, ListAttributes will list attributes of the link itself.
kNoSecurity 8
kReplace 4 Fail if the named attribute does not exist. Failure to specify kReplace or kCreate allows creation and replacement.
kShowCompression 32 ListAttributes will list HFS Plus Compression extended attribute(s) (if present) for the file referred to by path.

Blog Entries

Xojo Developer Magazine

Videos


The items on this page are in the following plugins: MBS MacOSX Plugin.


The biggest plugin in space...