Platforms to show: All Mac Windows Linux Cross-Platform
Back to FileListMBS class.
FileListMBS.AttributeModificationDate(index as Integer) as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 9.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
On Mac OS the UTC date (+0 time zone)
Raises an exception if index is out of bounds. Index is zero based.
See also:
FileListMBS.AttributeModificationDate(index as Integer, UTC as boolean) as Date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 13.4 | ✅ Yes | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
See also:
FileListMBS.AttributeModificationDateTime(index as integer, UTC as boolean) as DateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.BackupDate(index as Integer) as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 9.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
On Mac OS the UTC date (+0 time zone)
See also:
FileListMBS.BackupDate(index as Integer, UTC as boolean) as Date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 13.4 | ✅ Yes | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
See also:
FileListMBS.BackupDateTime(index as integer, UTC as boolean) as DateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.CFURL(index as integer) as Variant
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 19.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns nil if no CFURL is kept for this item.
Raises an exception if index is out of bounds. Index is zero based.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
There is no need to call this method except you want to free all resources of this object now without waiting for Xojo to do it for you.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.4 | ✅ Yes | ❌ No | ✅ Yes | ✅ Yes | All |
See also:
FileListMBS.Constructor(filelist as FileListMBS, index as Integer, WinFilter as string = "", SkipMode as Integer = 0)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 6.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If count is 0 after the contrustor the folder is invalid or empty.
On Windows the WinFilter allows you to pass a custom filter like "*.txt" to only find some files there.
SkipMode, added in version 20.1, allows you to skip some files from being part of the file list. Please use BitwiseOr() to combine Skip flags, e.g. BitwiseOr(SkipHidden, SkipFolders) returns only visible files.
See also:
FileListMBS.Constructor(folder as folderitem, WinFilter as string = "", SkipMode as Integer = 0)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If count is 0 after the contrustor the folder is invalid or empty.
On Windows the WinFilter allows you to pass a custom filter like "*.txt" to only find some files there.
SkipMode, added in version 20.1, allows you to skip some files from being part of the file list. Please use BitwiseOr() to combine Skip flags, e.g. BitwiseOr(SkipHidden, SkipFolders) returns only visible files.
See also:
FileListMBS.Constructor(Path as String, WinFilter as string = "", SkipMode as Integer = 0)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 16.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If count is 0 after the contrustor the directory path is invalid or empty.
On Windows the WinFilter allows you to pass a custom filter like "*.txt" to only find some files there.
SkipMode, added in version 20.1, allows you to skip some files from being part of the file list. Please use BitwiseOr() to combine Skip flags, e.g. BitwiseOr(SkipHidden, SkipFolders) returns only visible files.
See also:
FileListMBS.CreationDate(index as Integer) as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
On Mac OS the UTC date (+0 time zone)
On Windows looks like local timezone.
See also:
FileListMBS.CreationDate(index as Integer, UTC as boolean) as Date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 13.4 | ✅ Yes | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
See also:
FileListMBS.CreationDateTime(index as integer, UTC as boolean) as DateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.Creator(index as Integer) as string Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ❌ No | ✅ Yes | ✅ Yes | All |
Always "" on Windows and Linux.
Raises an exception if index is out of bounds. Index is zero based.
Stopped working on macOS Monterey and newer since Apple deprecated the API long ago.
FileListMBS.Directory(index as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
True if it is a folder and false if it is a file.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.DisplayName(index as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Asks the System for the display name of the item. Returns the normal name on any error.
As this call may cost quite some CPU time you may cache the value if you need it more often.
May return a Unicode string, so be carefull with encoding.
Returns "" on any error.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.FinderFlags(index as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 6.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
On Windows and Linux value is 0.
The flag value is a set of bits with the following meaning:
bit 15 | value &H8000 | isAlias |
bit 14 | value &H4000 | isInvisible |
bit 13 | value &H2000 | hasBundle (has a BNDL resource) |
bit 12 | value &H1000 | nameLocked |
bit 11 | value &H0800 | isStationary |
bit 10 | value &H0400 | hasCustomIcon |
bit 8 | value &H0100 | hasBeenInited (Finder has seen the file since it has been created) |
bit 7 | value &H0080 | hasNoINITs (there is no INIT rsrc in the Extension file) |
bit 6 | value &H0040 | isShared |
bits 1-3 | value &H000E | color (as a 3-bit value from 0-7) |
FileListMBS.FSRef(index as Integer) as memoryblock Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns nil if no FSRef is kept for this item.
On Mac OS there is a FSSpec or (FSRef and HFSUniStr255).
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.HFSUniStr255(index as Integer) as memoryblock Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.2 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns nil if no HFSUniStr255 is kept for this item.
On Mac OS there is a FSSpec or (FSRef and HFSUniStr255).
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.IsBundle(index as Integer) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 6.1 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
On Windows, Linux and Mac OS Classic always false.
FileListMBS.IsHardLinked(index as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 9.4 | ✅ Yes | ❌ No | ✅ Yes | ✅ Yes | All |
If two directory entries point to the same hard disc space, you have a file which has two directory entries, but only one storage.
This function returns true for files in a Time Machine backup which did not change since the last backup and share their disc space with the other backups.
Raises an exception if index is out of bounds. Index is zero based.
Some examples using this method:
FileListMBS.Item(index as Integer) as folderitem
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns nil on any error.
The reason why you use this class is to avoid makeing folderitems which is slow, so don't use this function too often.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.ItemPath(index as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 16.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Some examples using this method:
FileListMBS.LastAccessDate(index as Integer) as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 9.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
On Mac OS the UTC date (+0 time zone)
Raises an exception if index is out of bounds. Index is zero based.
To query Spotlight's Last Open day, please check the FAQ for sampel code.
See also:
FileListMBS.LastAccessDate(index as Integer, UTC as boolean) as Date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 13.4 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
To query Spotlight's Last Open day, please check the FAQ for sample code.
See also:
FileListMBS.LastAccessDateTime(index as integer, UTC as boolean) as DateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
To query Spotlight's Last Open day, please check the FAQ for sample code.
FileListMBS.LogicalDataLength(index as Integer) as Int64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Same value as folderitem.length, but works with files >2GB.
Raises an exception if index is out of bounds. Index is zero based.
Some examples using this method:
FileListMBS.LogicalResourceLength(index as Integer) as Int64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.ModificationDate(index as Integer) as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
On Mac OS the UTC date (+0 time zone)
On Windows looks like local timezone.
Raises an exception if index is out of bounds. Index is zero based.
See also:
FileListMBS.ModificationDate(index as Integer, UTC as boolean) as Date
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 13.4 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
See also:
FileListMBS.ModificationDateTime(index as integer, UTC as boolean) as DateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Either in UTC time zone or in local time zone.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.Name(index as Integer) as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
May return a Unicode string, so be carefull with encoding.
Returns "" on any error.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.NodeID(index as Integer) as Int64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 9.1 | ✅ Yes | ❌ No | ✅ Yes | ✅ Yes | All |
The node id is zero on Windows and Linux.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.ParentDirectoryID(index as Integer) as Int64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 9.1 | ✅ Yes | ❌ No | ✅ Yes | ✅ Yes | All |
Parent Directory ID is zero on Windows and Linux.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.PhysicalDataLength(index as Integer) as Int64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns 0 on any error.
Raises an exception if index is out of bounds. Index is zero based.
Some examples using this method:
FileListMBS.PhysicalResourceLength(index as Integer) as Int64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Value is always 0 on Windows.
Returns 0 on any error.
Raises an exception if index is out of bounds. Index is zero based.
Some examples using this method:
FileListMBS.SortByCreationDate
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 6.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 19.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
FileListMBS.SortByModificationDate
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 6.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
FileListMBS.TrueItem(index as Integer) as folderitem
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Returns nil on any error.
The reason why you use this class is to avoid makeing folderitems which is slow, so don't use this function too often. e.g. good if you just take 5 folderitems for 20000 files by filtering.
TrueItem will use GetTrueFolderItem so the link/alias files are not resolved by Xojo.
Due to bugs in Xojo, you may still get alias resolved.
Some examples using this method:
FileListMBS.Type(index as Integer) as string Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ❌ No | ✅ Yes | ✅ Yes | All |
Always "" on Windows and Linux.
Raises an exception if index is out of bounds. Index is zero based.
Stopped working on macOS Monterey and newer since Apple deprecated the API long ago.
FileListMBS.Visible(index as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 5.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
On Mac OS X, files with name starting with "." are considered to be invisible.
False on any error.
Raises an exception if index is out of bounds. Index is zero based.
FileListMBS.WinFileAttributes(index as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Files | MBS Util Plugin | 6.1 | ✅ Yes | ✅ Yes | ❌ No | ✅ Yes | All |
Value is 0 on other platforms.
Raises an exception if index is out of bounds. Index is zero based.
The items on this page are in the following plugins: MBS Util Plugin.