class FileListMBS
class, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: A class for a list of files.
Notes: This class is made to get a list of files in a folder faster than by using a folderitem.

FileListMBS.Close
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The destructor.
Notes:
There is no need to call this method except you want to free all resources of this object now without waiting for Realbasic to do it for you.
(e.g. some Realbasic versions crash on Windows if there are plugin objects not closed.)

FileListMBS.Constructor(filelist as FileListMBS, index as integer)
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The constructor which creates a new file list based on item in a given file list.
Notes: If count is 0 after the contrustor the folder is invalid or empty.

FileListMBS.Constructor(folder as folderitem)
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The constructor which creates a new file list based on the folder.
Notes: If count is 0 after the contrustor the folder is invalid or empty.

FileListMBS.Count as Integer
property, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The number of items found.
Notes:
So index goes from 0 to count-1 in all functions.
(Read and Write property)

FileListMBS.CreationDate(index as integer) as double
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The creation date.
Notes:
On Mac OS the UTC date (+0 time zone)
On Windows looks like local timezone.

FileListMBS.Directory(index as integer) as boolean
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Whether the item with the given index is a folder.
Notes:
True if it is a folder.
False if not or out of bounds.

FileListMBS.DisplayName(index as integer) as string
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The display name of the item with the given index.
Notes:
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.

FileListMBS.FinderFlags(index as integer) as Integer
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The Finder flags from Mac OS.
Notes:
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.Folder as Folderitem
property, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The folderitem used in the constructor.
Notes: (Read and Write property)

FileListMBS.IsBundle(index as integer) as Boolean
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Queries using LaunchServices whether this item is a folder and the root of a bundle.
Example:

Protected Sub Dir(f as FolderItem)
  dim l as FileListMBS
  dim i,c as integer
  
  // search subfolders and find bundles
  
  l=new FileListMBS(f)
  c=l.Count-1
  for i=0 to c
    // if bundle, show it in listbox
    if l.IsBundle(i) then
      ListBox1.AddRow l.Item(i).AbsolutePath
    elseif l.Directory(i) then
      // if sub folder, browse it
      dir l.Item(i)
    end if
  next
End Sub

Notes: On Windows, Linux and Mac OS Classic always false.

FileListMBS.Item(index as integer) as folderitem
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Creates a folderitem for the item with the given index.
Notes:
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.

FileListMBS.LogicalDataLength(index as integer) as double
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The logical file data length for the item with the given index.
Notes: Same value as folderitem.length, but works with files >2GB.

FileListMBS.LogicalResourceLength(index as integer) as double
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The logical resource length of the item with the given index.

FileListMBS.ModificationDate(index as integer) as double
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The modification date.
Notes:
On Mac OS the UTC date (+0 time zone)
On Windows looks like local timezone.

FileListMBS.Name(index as integer) as string
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The name of the item with the given index.
Notes:
May return a Unicode string, so be carefull with encoding.
Returns "" on any error.

FileListMBS.OK as Boolean
property, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 6.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Whether the process of reading the directory content in the constructor was successful.
Notes:
Should be true on success.
(Read and Write property)

FileListMBS.PhysicalDataLength(index as integer) as double
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The physical data length of the item with the given index.
Notes: Returns 0 on any error.

FileListMBS.PhysicalResourceLength(index as integer) as double
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The physical resource length of the item with the given index.
Notes:
Value is always 0 on Windows.
Returns 0 on any error.

FileListMBS.SortByCreationDate
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 6.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Sorts items in list by creation date.

FileListMBS.SortByModificationDate
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 6.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Sorts items in list by modification date.

FileListMBS.TrueItem(index as integer) as folderitem
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 8.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Creates a folderitem for the item with the given index.
Notes:
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.

TrueItem will on Windows use GetTrueFolderItem instead of GetFolderItem so the link files are not resolved by Realbasic.

FileListMBS.Visible(index as integer) as boolean
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Whether the item with the given index is visible.
Notes:
On Mac OS X, files with name starting with "." are considered to be invisible.
False on any error.

FileListMBS.WinFileAttributes(index as integer) as integer
method, Files, MBS Util Plugin (FileList), class FileListMBS, Console safe, Plugin version: 6.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The file attributes for this file on Windows.
Notes: Value is 0 on other platforms or on invalid index.