Platforms to show: All Mac Windows Linux Cross-Platform
folderitem.AbsolutePath as string
Function:
Returns the absolute path for the file.
Example:
Notes:
For Xojo we register this function for compatibility to older Xojo and Real Studio versions.
Same as AbsolutePathMBS, but with name AbsolutePath.
On MacOS queries absolute path in MacOS Classic HFS style, but on Windows and Linux just queries native path.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacOSX Plugin | 19.5 | Yes | Yes | Yes | Yes | No |
Example:
// test absolute path
Dim f As FolderItem = SpecialFolder.Desktop.Child("test.txt")
Dim p As String = f.AbsolutePath
Dim g As FolderItem = NewFolderItemFromAbsolutePathMBS(p)
Dim n As String = g.NativePath
MsgBox p+EndOfLine+n
For Xojo we register this function for compatibility to older Xojo and Real Studio versions.
Same as AbsolutePathMBS, but with name AbsolutePath.
On MacOS queries absolute path in MacOS Classic HFS style, but on Windows and Linux just queries native path.
folderitem.AbsolutePathMBS as string
Function:
Returns the absolute path for the file.
Example:
Notes:
On MacOS queries absolute path in MacOS Classic HFS style, but on Windows and Linux just queries native path.
Version 20.1 or newer makes sure directories return a path ending in double colon.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacOSX Plugin | 19.5 | Yes | Yes | Yes | Yes | No |
Example:
// test absolute path
Dim f As FolderItem = SpecialFolder.Desktop.Child("test.txt")
Dim p As String = f.AbsolutePathMBS
Dim g As FolderItem = NewFolderItemFromAbsolutePathMBS(p)
Dim n As String = g.NativePath
MsgBox p+EndOfLine+n
On MacOS queries absolute path in MacOS Classic HFS style, but on Windows and Linux just queries native path.
Version 20.1 or newer makes sure directories return a path ending in double colon.
folderitem.AccessDateMBS(UTC as boolean = false) as date
Function:
The access date of the file or folder.
Example:
Notes:
Setting this value is not supported on Linux currently.
To query Spotlight's Last Open day, please check the FAQ for sample code.
If UTC is true, you get/set date object where time is UTC.
(Read and Write computed property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Files | MBS Util Plugin | 10.1 | Yes | Yes | Yes | Yes | No |
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.txt")
dim xd as date = f.AccessDateMBS
MsgBox xd.LongDate+" "+xd.LongTime
Setting this value is not supported on Linux currently.
To query Spotlight's Last Open day, please check the FAQ for sample code.
If UTC is true, you get/set date object where time is UTC.
(Read and Write computed property)
Some examples using this property:
folderitem.AddedToDirectoryDateMBS as date
Function:
Returns the date the file was added to the folder.
Notes: Requires OS X 10.10 or newer.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | 16.4 | Yes | No | No | Yes, macOS only | No |
Notes: Requires OS X 10.10 or newer.
folderitem.AttributeModificationDateMBS(UTC as boolean = false) as date
Function:
The attribute modification date of the file or folder.
Example:
Notes:
Attribute Motification dates are supported only on Mac OS X currently.
If UTC is true, you get/set date object where time is UTC.
(Read and Write computed property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Files | MBS Util Plugin | 10.1 | Yes | Yes | Yes | Yes | No |
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.txt")
dim xd as date = f.AttributeModificationDateMBS
MsgBox xd.LongDate+" "+xd.LongTime
Attribute Motification dates are supported only on Mac OS X currently.
If UTC is true, you get/set date object where time is UTC.
(Read and Write computed property)
Some examples using this property:
folderitem.BackupDateMBS(UTC as boolean = false) as date
Function:
The backup date of the file or folder.
Example:
Notes:
Backup dates are supported only on Mac OS X currently.
If UTC is true, you get/set date object where time is UTC.
(Read and Write computed property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Files | MBS Util Plugin | 10.1 | Yes | No | No | Yes, macOS only | No |
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.txt")
dim xd as date = f.BackupDateMBS
MsgBox xd.LongDate+" "+xd.LongTime
Backup dates are supported only on Mac OS X currently.
If UTC is true, you get/set date object where time is UTC.
(Read and Write computed property)
Some examples using this property:
Folderitem.BackupIsItemExcludedMBS(byref excludeByPath as boolean) as boolean
Function:
Report whether or not an item is being excluded from backup.
Notes:
excludeByPath: pass a boolean variable to determine whether or not the given item is excluded as an absolute path or whether it is sticky to the item.
Returns true if the item or any of its ancestors are excluded from backup, false otherwise.
Require Mac OS X 10.5.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacFrameworks Plugin | 7.7 | Yes | No | No | Yes, macOS only | No |
Notes:
excludeByPath: pass a boolean variable to determine whether or not the given item is excluded as an absolute path or whether it is sticky to the item.
Returns true if the item or any of its ancestors are excluded from backup, false otherwise.
Require Mac OS X 10.5.
Folderitem.BackupItemExcludedMBS as boolean
Function:
Whether or not an item is being excluded from backup.
Notes:
This is the easy method to just query whether a file is marked as being excluded from backup. You can assign a boolean value to exclude (true) or include (false) the file.
Require Mac OS X 10.5. Returns false on all other operation systems.
(Read and Write computed property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Files | MBS MacFrameworks Plugin | 7.7 | Yes | No | No | Yes, macOS only | No |
Notes:
This is the easy method to just query whether a file is marked as being excluded from backup. You can assign a boolean value to exclude (true) or include (false) the file.
Require Mac OS X 10.5. Returns false on all other operation systems.
(Read and Write computed property)
Folderitem.BackupSetItemExcludedMBS(exclude as boolean, excludeByPath as boolean) as Integer
Function:
Add or remove an item from the list of items excluded from backup.
Notes:
When backing up, the backup daemon skips items marked by this call. If a folder is marked for exclusion, it and its contents are excluded from backup. When specifying by path, it is OK to pass a URL of an item/folder that does not exist yet.
Returns the error code. -1 is the error code in case the function is not available.
Require Mac OS X 10.5.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacFrameworks Plugin | 7.7 | Yes | No | No | Yes, macOS only | No |
Notes:
When backing up, the backup daemon skips items marked by this call. If a folder is marked for exclusion, it and its contents are excluded from backup. When specifying by path, it is OK to pass a URL of an item/folder that does not exist yet.
Returns the error code. -1 is the error code in case the function is not available.
Require Mac OS X 10.5.
folderitem.CalculateDirectorySizeMBS(recursive as boolean = false, ticks as Integer = 0, QueryCompressedSizes as boolean = false, RecursionLimit as Integer = -1) as DirectorySizeMBS
Function:
Returns an object with informations about the folder size.
Example:
Notes:
recursive: Whether to count items in the subfolders.
ticks: Whether to yield time to other threads. (See YieldTicks property)
QueryCompressedSizes: Whether to query compressed file sizes on Windows.
RecursionLimit: If positive, the recursion limit.
Returns nil on any error.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | 3.3 | Yes | Yes | Yes | Yes | No |
Example:
// chose a folder
dim f as FolderItem = SelectFolder
// calculate
dim d as DirectorySizeMBS = f.CalculateDirectorySizeMBS(True,0)
// display
MsgBox str(d.FilesCount)+" files in "+str(d.FolderCount)+" folder"
recursive: Whether to count items in the subfolders.
ticks: Whether to yield time to other threads. (See YieldTicks property)
QueryCompressedSizes: Whether to query compressed file sizes on Windows.
RecursionLimit: If positive, the recursion limit.
Returns nil on any error.
Some examples using this method:
Folderitem.CommentMBS as string
Function:
The comment for that file.
Example:
Notes:
This function sends an AppleEvent to the Finder. It may take some milliseconds.
(on Mac OS X)
Querying comment is not thread safe.
Your application needs to be allowed to control Finder via AppleScripts.
See DeterminePermissionToAutomateTarget method in NSAppleScriptMBS class.
see also
https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_automation_apple-events
(Read and Write computed property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Files | MBS MacClassic Plugin | Yes | No | No | Yes, macOS only | No |
Example:
dim f as folderitem // your file
f.CommentMBS="Hello world!"
This function sends an AppleEvent to the Finder. It may take some milliseconds.
(on Mac OS X)
Querying comment is not thread safe.
Your application needs to be allowed to control Finder via AppleScripts.
See DeterminePermissionToAutomateTarget method in NSAppleScriptMBS class.
see also
https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_automation_apple-events
(Read and Write computed property)
Some examples using this property:
folderitem.CompressedFileLengthMBS as int64
Function:
Returns the length of the compressed file on disk.
Example:
Notes:
On Windows files can be compressed and this function returns the size of the compressed file. On Mac and for non compressed files on Windows this function returns the uncompressed size.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | 7.4 | Yes | Yes | Yes | Yes | No |
Example:
filesize.text=format(file.CompressedFileLengthMBS,"0")
Folderitem.CountMBS as Integer
Function:
Returns the number of items in this folder.
Example:
The count property of the Xojo folderitem class is cached.
So if you create a file, the count property may not update.
If you need a more up to date value, you can use the CountMBS function to return the value the Mac OS system software returns.
On any error (e.g. invalid folderitem) the function returns 0.
Windows support added in 4.2dr2.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacClassic Plugin | 3.2 | Yes | Yes | No | Yes | No |
Example:
dim f as FolderItem = SpecialFolder.Desktop
MsgBox str(F.Count)+" vs. "+str(F.CountMBS)
This item is deprecated and should no longer be used.
You can use folderitem.Count instead.
Notes:
The count property of the Xojo folderitem class is cached.
So if you create a file, the count property may not update.
If you need a more up to date value, you can use the CountMBS function to return the value the Mac OS system software returns.
On any error (e.g. invalid folderitem) the function returns 0.
Windows support added in 4.2dr2.
Some examples using this method:
Folderitem.CreateLargeBinaryStreamMBS(MacType as string, MacCreator as string) as LargeBinaryStreamMBS
Function:
Creates a file as a LargeBinaryStreamMBS.
Example:
Notes:
If there is already a file, it is deleted.
On Windows the parameters are ignored.
Returns nil on any error.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | Yes | Yes | Yes | Yes | No |
Example:
dim f as FolderItem // your file
dim l as LargeBinaryStreamMBS
l=f.CreateLargeBinaryStreamMBS("TEXT","ttxt")
If there is already a file, it is deleted.
On Windows the parameters are ignored.
Returns nil on any error.
Some examples using this method:
folderitem.CreateResStreamMBS(MacType as string, MacCreator as string) as ResStreamMBS
Function:
Creates a new ResStreamMBS.
Notes:
If there is already a file, it is deleted.
If the file could not be created it is deleted.
Returns nil on any error.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | Yes | No | No | Yes, macOS only | No |
Notes:
If there is already a file, it is deleted.
If the file could not be created it is deleted.
Returns nil on any error.
Some examples using this method:
folderitem.CreationDateMBS(UTC as boolean = false) as date
Function:
The creation date of the file or folder.
Example:
Notes:
Setting this value is not supported on Linux currently.
If UTC is true, you get/set date object where time is UTC.
(Read and Write computed property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Files | MBS Util Plugin | 10.1 | Yes | Yes | Yes | Yes | No |
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.txt")
dim xd as date = f.CreationDateMBS
MsgBox xd.LongDate+" "+xd.LongTime
Setting this value is not supported on Linux currently.
If UTC is true, you get/set date object where time is UTC.
(Read and Write computed property)
Some examples using this property:
Folderitem.CreatorAppMBS as FolderItem
Function:
Returns the application that would be launched if you'd call the above Launch method, or NIL if no appropriate app can be located.
Example:
Notes:
This function doesn't work with bundles and should be only used on Mac OS 9.
Use Launch service functions on Mac OS X.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacClassic Plugin | Yes | No | No | Yes, macOS only | No |
Example:
dim docfile as folderitem // your document file
dim appfile as folderitem
appfile=docfile.CreatorAppMBS
This function doesn't work with bundles and should be only used on Mac OS 9.
Use Launch service functions on Mac OS X.
See also:
Some examples using this method:
Folderitem.CreatorAppMBS(creatorCode as String) as FolderItem
Function:
Returns a folderitem to the Application which created this file for the given creator code on the volume of the folderitem.
Example:
Notes:
Returns the application that would be launched if you'd call the above Launch method and if the file had the specified creator code. Returns NIL if no appropriate app can be located.
This method allows you to open a document with a creator code that you specify instead of having to locate the application by your own. Here's an example on how to open any file with ResEdit (whose creator code is 'RSED'):
This function doesn't work with bundles and should be only used on Mac OS 9.
Use Launch service functions on Mac OS X.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacClassic Plugin | Yes | No | No | Yes, macOS only | No |
Example:
dim myvolume as folderitem // your volume
dim theFile as folderitem // your file
dim appfile as folderitem
dim ok as boolean
dim inFront as Boolean
appfile=myvolume.CreatorAppMBS("iCAB")
' or
ok = theFile.OpenWithAppMBS(myvolume.CreatorAppMBS("RSED"), inFront)
Returns the application that would be launched if you'd call the above Launch method and if the file had the specified creator code. Returns NIL if no appropriate app can be located.
This method allows you to open a document with a creator code that you specify instead of having to locate the application by your own. Here's an example on how to open any file with ResEdit (whose creator code is 'RSED'):
This function doesn't work with bundles and should be only used on Mac OS 9.
Use Launch service functions on Mac OS X.
See also:
Some examples using this method:
folderitem.DarwinMediaClassMBS as string
Function:
Returns the class of the media.
Example:
Notes:
Returns nil on any problem.
Possible values:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacCF Plugin | 3.1 | Yes | No | No | Yes, macOS only | No |
Example:
dim f as FolderItem = SpecialFolder.Desktop
MsgBox f.DarwinMediaClassMBS
Returns nil on any problem.
Possible values:
| kIOCDMediaClass | "IOCDMedia" |
| kIODVDMediaClass | "IODVDMedia" |
| kIOMediaClass | "IOMedia" |
Some examples using this method:
folderitem.DarwinMediaInfoMBS as CFDictionaryMBS
Function:
Returns the info dictionary of the media.
Example:
Notes:
Returns nil on any problem.
example output for the example code above:
<CFDictionary 0x7d60510 [0xa01900e0]>{type = fixed-mutable, count = 14, capacity = 14, pairs = (
0 : <CFString 0x7d5ffe0 [0xa01900e0]>{contents = "Leaf"} = <CFBoolean 0xa0190b98 [0xa01900e0]>{value = false}
1 : <CFString 0x7d60160 [0xa01900e0]>{contents = "Writable"} = <CFBoolean 0xa0190b90 [0xa01900e0]>{value = true}
2 : <CFString 0x7d60310 [0xa01900e0]>{contents = "BSD Minor"} = <CFNumber 0x7d60300 [0xa01900e0]>{value = +0, type = kCFNumberSInt32Type}
6 : <CFString 0x7d60040 [0xa01900e0]>{contents = "Preferred Block Size"} = <CFNumber 0x7d5fe90 [0xa01900e0]>{value = +512, type = kCFNumberSInt64Type}
11 : <CFString 0x7d604c0 [0xa01900e0]>{contents = "BSD Major"} = <CFNumber 0x7d604b0 [0xa01900e0]>{value = +14, type = kCFNumberSInt32Type}
13 : <CFString 0x7d603b0 [0xa01900e0]>{contents = "BSD Name"} = <CFString 0x7d60110 [0xa01900e0]>{contents = "disk0"}
14 : <CFString 0x7d600d0 [0xa01900e0]>{contents = "Size"} = <CFNumber 0x7d60090 [0xa01900e0]>{value = +163928604672, type = kCFNumberSInt64Type}
15 : <CFString 0x7d5fef0 [0xa01900e0]>{contents = "Content Hint"} = <CFString 0xa0196304 [0xa01900e0]>{contents = ""}
16 : <CFString 0x7d60020 [0xa01900e0]>{contents = "Removable"} = <CFBoolean 0xa0190b98 [0xa01900e0]>{value = false}
17 : <CFString 0x7d601b0 [0xa01900e0]>{contents = "IOMediaIcon"} = <CFDictionary 0x7d60360 [0xa01900e0]>{type = fixed-mutable, count = 2, capacity = 2, pairs = (
2 : <CFString 0x7d60250 [0xa01900e0]>{contents = "CFBundleIdentifier"} = <CFString 0x7d602a0 [0xa01900e0]>{contents = "com.apple.iokit.IOStorageFamily"}
3 : <CFString 0x7d5ff30 [0xa01900e0]>{contents = "IOBundleResourceFile"} = <CFString 0x7d60230 [0xa01900e0]>{contents = "Internal.icns"}
)}
19 : <CFString 0x7d603d0 [0xa01900e0]>{contents = "BSD Unit"} = <CFNumber 0x7d5ff50 [0xa01900e0]>{value = +0, type = kCFNumberSInt32Type}
20 : <CFString 0x7d5ff90 [0xa01900e0]>{contents = "Ejectable"} = <CFBoolean 0xa0190b98 [0xa01900e0]>{value = false}
21 : <CFString 0x7d5fea0 [0xa01900e0]>{contents = "Content"} = <CFString 0x7d5ff10 [0xa01900e0]>{contents = "Apple_partition_scheme"}
22 : <CFString 0x7d60120 [0xa01900e0]>{contents = "Whole"} = <CFBoolean 0xa0190b90 [0xa01900e0]>{value = true}
)}
If you don't like all the CFDictionaryMBS methods, than use Dictionary function it to get a Xojo dictionary.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacCF Plugin | 5.1 | Yes | No | No | Yes, macOS only | No |
Example:
// info for boot volume
dim info as CFDictionaryMBS = volume(0).DarwinMediaInfoMBS
if info = nil then
beep // error
else
CFShowMBS info // show in console
dim RemovableKey as CFStringMBS = NewCFStringMBS("Removable")
dim RemovableCFO as CFObjectMBS = info.Value(RemovableKey)
dim RemovableCFB as CFBooleanMBS = CFBooleanMBS(RemovableCFO)
dim Removable as Boolean = RemovableCFB.Value
MsgBox "Removable: "+str(Removable)
dim EjectableKey as CFStringMBS = NewCFStringMBS("Ejectable")
dim EjectableCFO as CFObjectMBS = info.Value(EjectableKey)
dim EjectableCFB as CFBooleanMBS = CFBooleanMBS(EjectableCFO)
dim Ejectable as Boolean = EjectableCFB.Value
MsgBox "Ejectable: "+str(Ejectable)
dim SizeKey as CFStringMBS = NewCFStringMBS("Size")
dim SizeCFO as CFObjectMBS = info.Value(SizeKey)
dim SizeCFN as CFNumberMBS = CFNumberMBS(SizeCFO)
dim Size as Double = SizeCFN.doubleValue / 1000000000.0
MsgBox "Size: "+str(Size, "0.0")+" GB"
end if
Returns nil on any problem.
example output for the example code above:
<CFDictionary 0x7d60510 [0xa01900e0]>{type = fixed-mutable, count = 14, capacity = 14, pairs = (
0 : <CFString 0x7d5ffe0 [0xa01900e0]>{contents = "Leaf"} = <CFBoolean 0xa0190b98 [0xa01900e0]>{value = false}
1 : <CFString 0x7d60160 [0xa01900e0]>{contents = "Writable"} = <CFBoolean 0xa0190b90 [0xa01900e0]>{value = true}
2 : <CFString 0x7d60310 [0xa01900e0]>{contents = "BSD Minor"} = <CFNumber 0x7d60300 [0xa01900e0]>{value = +0, type = kCFNumberSInt32Type}
6 : <CFString 0x7d60040 [0xa01900e0]>{contents = "Preferred Block Size"} = <CFNumber 0x7d5fe90 [0xa01900e0]>{value = +512, type = kCFNumberSInt64Type}
11 : <CFString 0x7d604c0 [0xa01900e0]>{contents = "BSD Major"} = <CFNumber 0x7d604b0 [0xa01900e0]>{value = +14, type = kCFNumberSInt32Type}
13 : <CFString 0x7d603b0 [0xa01900e0]>{contents = "BSD Name"} = <CFString 0x7d60110 [0xa01900e0]>{contents = "disk0"}
14 : <CFString 0x7d600d0 [0xa01900e0]>{contents = "Size"} = <CFNumber 0x7d60090 [0xa01900e0]>{value = +163928604672, type = kCFNumberSInt64Type}
15 : <CFString 0x7d5fef0 [0xa01900e0]>{contents = "Content Hint"} = <CFString 0xa0196304 [0xa01900e0]>{contents = ""}
16 : <CFString 0x7d60020 [0xa01900e0]>{contents = "Removable"} = <CFBoolean 0xa0190b98 [0xa01900e0]>{value = false}
17 : <CFString 0x7d601b0 [0xa01900e0]>{contents = "IOMediaIcon"} = <CFDictionary 0x7d60360 [0xa01900e0]>{type = fixed-mutable, count = 2, capacity = 2, pairs = (
2 : <CFString 0x7d60250 [0xa01900e0]>{contents = "CFBundleIdentifier"} = <CFString 0x7d602a0 [0xa01900e0]>{contents = "com.apple.iokit.IOStorageFamily"}
3 : <CFString 0x7d5ff30 [0xa01900e0]>{contents = "IOBundleResourceFile"} = <CFString 0x7d60230 [0xa01900e0]>{contents = "Internal.icns"}
)}
19 : <CFString 0x7d603d0 [0xa01900e0]>{contents = "BSD Unit"} = <CFNumber 0x7d5ff50 [0xa01900e0]>{value = +0, type = kCFNumberSInt32Type}
20 : <CFString 0x7d5ff90 [0xa01900e0]>{contents = "Ejectable"} = <CFBoolean 0xa0190b98 [0xa01900e0]>{value = false}
21 : <CFString 0x7d5fea0 [0xa01900e0]>{contents = "Content"} = <CFString 0x7d5ff10 [0xa01900e0]>{contents = "Apple_partition_scheme"}
22 : <CFString 0x7d60120 [0xa01900e0]>{contents = "Whole"} = <CFBoolean 0xa0190b90 [0xa01900e0]>{value = true}
)}
If you don't like all the CFDictionaryMBS methods, than use Dictionary function it to get a Xojo dictionary.
folderitem.DarwinVolumeNameMBS as string
Function:
Returns the name of the volume from the BSD part of Mac OS X.
Example:
Notes:
Returns "" on any error.
The returned string is encoded as ASCII.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacCF Plugin | 3.1 | Yes | No | No | Yes, macOS only | No |
Example:
MsgBox Volume(0).DarwinVolumeNameMBS // shows here disk1s10
Returns "" on any error.
The returned string is encoded as ASCII.
Some examples using this method:
Folderitem.DeleteDataForkMBS
Function:
Deletes the data fork of a file.
Notes:
Equal to open the file using a binarystream and setting the length property to 0.
On Mac OS a file can exist without a datafork, with a resource fork or even without any fork.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | Yes | No | No | Yes, macOS only | No |
Notes:
Equal to open the file using a binarystream and setting the length property to 0.
On Mac OS a file can exist without a datafork, with a resource fork or even without any fork.
Folderitem.DeleteResourceForkMBS
Function:
Deletes the resource fork of a file.
Notes:
Equal to open the file using a ResStreamMBS and setting the length property to 0.
On Mac OS a file can exist without a datafork, with a resource fork or even without any fork.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | Yes | No | No | Yes, macOS only | No |
Notes:
Equal to open the file using a ResStreamMBS and setting the length property to 0.
On Mac OS a file can exist without a datafork, with a resource fork or even without any fork.
folderitem.DisplayPathMBS(delimiter as string = "/") as string
Function:
Shows display path.
Example:
Notes:
You can pass any string for delimiter. Good looks an arrow or just a slash.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | 9.8 | Yes | Yes | Yes | Yes | No |
Example:
// Sample values in German:
// SnowLeopard/Programme/Dienstprogramme/Konsole
MsgBox SpecialFolder.Applications.Child("Utilities").Child("Console.app").DisplayPathMBS("/")
// SnowLeopard/Benutzer/cs/Schreibtisch
MsgBox SpecialFolder.Desktop.DisplayPathMBS("/")
// SnowLeopard ➜ Programme ➜ Dienstprogramme ➜ Konsole
MsgBox SpecialFolder.Applications.Child("Utilities").Child("Console.app").DisplayPathMBS(" ➜ ")
// SnowLeopard ➜ Benutzer ➜ cs ➜ Schreibtisch
MsgBox SpecialFolder.Desktop.DisplayPathMBS(" ➜ ")
folderitem.EjectVolumeMBS(force as boolean, byref dissenterPID as Integer) as Integer
Function:
This routine ejects the volume specified by folderitem.
Example:
Notes:
If the volume cannot be ejected the pid of the process which denied the unmount will be returned in the dissenter parameter. This routine returns after the eject is complete. Ejecting a volume will result in the unmounting of other volumes on the same device.
force: Specify true if you want the volume forcibly unmounted. Force unmounting a volume will very likely result in data loss since the volume will be ejected even if there are open files on it. This option should be reserved for situations such as the backing store for a volume is gone (so the data is lost regardless).
dissenterPID: Optionally, pid of the process which denied the unmount if the unmount is denied.
Returns a Mac OS error code. 0 means no error and -1 is a plugin error if the function can't be called. -47 is returned if the disc is in use.
PS: Seems like on my tests the pid is not set by Apple.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacClassic Plugin | 10.3 | Yes | No | No | Yes, macOS only | No |
Example:
dim disk as FolderItem
dim c as Integer = VolumeCount-1
for i as Integer = 0 to c
dim v as FolderItem = volume(i)
if v.Name = "testvolume" then
disk = v
exit
end if
next
if disk = nil then
MsgBox "Please change the name in this code."
else
dim pid as Integer
dim e as Integer = disk.EjectVolumeMBS(false, pid)
if e=0 then
msgBox "Volume unmounted."
else
if pid=0 then
msgBox "Failed to unmount with error: "+str(e)
else
dim name as string
dim p as new ProcessMBS // from Util plugin
p.GetFirstProcess
do
if p.ProcessID = pid then
name = p.Name
end if
loop until not p.GetNextProcess
if len(name)>0 then
msgBox "Failed to unmount with error: "+str(e)
else
MsgBox "Failed to unmount."+EndOfLine+EndOfLine+"The application "+name+" is still using this volume."+EndOfLine+"Error: "+str(e)
end if
end if
end if
end if
If the volume cannot be ejected the pid of the process which denied the unmount will be returned in the dissenter parameter. This routine returns after the eject is complete. Ejecting a volume will result in the unmounting of other volumes on the same device.
force: Specify true if you want the volume forcibly unmounted. Force unmounting a volume will very likely result in data loss since the volume will be ejected even if there are open files on it. This option should be reserved for situations such as the backing store for a volume is gone (so the data is lost regardless).
dissenterPID: Optionally, pid of the process which denied the unmount if the unmount is denied.
Returns a Mac OS error code. 0 means no error and -1 is a plugin error if the function can't be called. -47 is returned if the disc is in use.
PS: Seems like on my tests the pid is not set by Apple.
FolderItem.FilesMBS as Folderitem()
Function:
Returns array of files in the given folder.
Example:
Notes:
Similar to item() function, but returns all files with one call.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | 12.0 | Yes | Yes | Yes | Yes | No |
Example:
dim folder as FolderItem = SpecialFolder.Desktop
dim files() as FolderItem = folder.FilesMBS
MsgBox str(UBound(files)+1)+" files"
Folderitem.FinderLabelMBS as Integer
Function:
Returns the color code for the file.
Example:
Notes:
The file label is a number between 0 and 7 to give the file a color.
Used in the Classic Finder for labels (and on Mac OS X for Finder replacement or Finder extending utilities)
On reading the value you can get negative values like -43 if the file is not found.
To know labels and colors, please use NSWorkspaceMBS.fileLabelColors and NSWorkspaceMBS.fileLabels methods.
(Read and Write computed property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| property | Files | MBS MacClassic Plugin | Yes | No | No | Yes, macOS only | No |
Example:
file.FinderLabelMBS=2
The file label is a number between 0 and 7 to give the file a color.
Used in the Classic Finder for labels (and on Mac OS X for Finder replacement or Finder extending utilities)
On reading the value you can get negative values like -43 if the file is not found.
To know labels and colors, please use NSWorkspaceMBS.fileLabelColors and NSWorkspaceMBS.fileLabels methods.
(Read and Write computed property)
Folderitem.FlushVolumeMBS as Integer
Function:
Asks the Mac OS to flush all write buffers to the disc.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS MacClassic Plugin | 3.3 | Yes | No | No | Yes, macOS only | No |
FolderItem.FoldersMBS as Folderitem()
Function:
Returns array of folders in the given folder.
Example:
Notes:
Similar to item() function, but returns all folders with one call.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
| method | Files | MBS Util Plugin | 12.0 | Yes | Yes | Yes | Yes | No |
Example:
dim folder as FolderItem = SpecialFolder.Desktop
dim folders() as FolderItem = folder.FoldersMBS
MsgBox str(UBound(folders)+1)+" folders"
The items on this page are in the following plugins: MBS MacCF Plugin, MBS MacClassic Plugin, MBS MacFrameworks Plugin, MBS MacOSX Plugin, MBS Util Plugin.
Links
MBS FileMaker Plugins
