Files
Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version
22.2
22.3
22.4
22.5
23.0
23.1
23.2
23.3
23.4
23.5
24.0
24.1
The list of the topics,
classes,
interfaces,
controls,
modules,
global methods by category,
global methods by name,
screenshots,
licenses
and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Files
Functions and classes for handling files and volumes.
- Screenshots
- Globals
- ExchangeFilesMBS(first as folderitem, second as folderitem) as Integer
- FolderItemToPathMBS(file as folderitem) as string
- GetDriveTypeMBS(path as string) as Integer
- MountMBS(URL as String, Dest as string = "", Username as String, Password as String, Interactive as boolean = false, Prompt as boolean = false, byref ErrorCode as Integer, Threaded as boolean = false) as String
- MountPathMBS(Path as String) as String
- MountPathMBS(Volume as FolderItem) as String
- NewFolderItemFromAbsolutePathMBS(AbsolutePath as string) as FolderItem
- NewFolderItemMBS(vRefNum as Integer, parID as Integer, name as String) as FolderItem
- NewVolumeFolderItemMBS(vRefNum as Integer) as FolderItem
- PathToFolderItemMBS(path as string) as folderitem
- SetCurrentWorkingDirectoryMBS(path as folderitem) as boolean
- UnmountMBS(Path as String, force as boolean = false) as Boolean
- UnmountMBS(Volume as FolderItem, force as boolean = false) as Boolean
- VolResolveIDMBS(volume as FolderItem, id as Integer) as FolderItem
- VolResolveIDMBS(vRefNum as Integer, id as Integer) as FolderItem
- VolumeFreeSizePathMBS(Path as String) as Int64
- VolumeSizePathMBS(Path as String) as Int64
- WindowsEjectVolumeMBS(driveLetter as string, byref status as Integer) as boolean
- Classes
- class ACLEntryMBS
- class ACLFlagSetMBS
- class ACLPermSetMBS
- class ACLRightMBS
- method Constructor(count as Integer)
- method Constructor(text as string)
- method CopyData(Native as boolean = false) as String
- method CreateEntry as ACLEntryMBS
- method CreateEntry(entryIndex as Integer, tag_type as Integer = 1) as ACLEntryMBS
- method DeleteEntry(entry as ACLEntryMBS)
- method Duplicate as ACLRightMBS
- method Entries as ACLEntryMBS()
- method Entry(entryIndex as Integer) as ACLEntryMBS
- shared method NewACL(count as Integer) as ACLRightMBS
- shared method NewACLFromExternal(data as string, native as boolean = false) as ACLRightMBS
- shared method NewACLFromFile(file as folderitem, type as Integer) as ACLRightMBS
- shared method NewACLFromFile(path as string, type as Integer) as ACLRightMBS
- shared method NewACLFromFilePointer(FilePointer as Integer) as ACLRightMBS
- shared method NewACLFromFilePointer(FilePointer as Integer, type as Integer) as ACLRightMBS
- shared method NewACLFromLink(path as string, type as Integer) as ACLRightMBS
- shared method NewACLFromText(text as string) as ACLRightMBS
- method SetFile(Path as string, type as Integer) as boolean
- method SetFilePointer(FilePointer as Integer) as boolean
- method SetFilePointer(FilePointer as Integer, type as Integer) as boolean
- method SetLink(Path as string, type as Integer) as boolean
- method Size as Int64
- method Text as String
- method Valid as boolean
- method ValidFile(Path as string, type as Integer) as boolean
- method ValidFilePointer(FilePointer as Integer, type as Integer) as boolean
- property Handle as Integer
- property Lasterror as Integer
- property FlagSet as ACLFlagSetMBS
- class CopyFileMBS
- method CopyFile(From as FolderItem, Dest as FolderItem, flags as Integer) as Integer
- method CopyFile(From as String, Dest as String, flags as Integer) as Integer
- shared method ErrorMessage(error as Integer) as String
- property BytesCopied as Int64
- property WasCloned as Boolean
- property XAttrName as String
- property YieldTicks as Integer
- event Progress(What as Integer, Stage as Integer, Source as String, Dest as String) as Integer
- class DADiskMBS
- class DADissenterMBS
- class DarwinChmodMBS
- method chflags(path as string, flags as Integer) as Integer
- method chmod(path as string, mode as Integer) as Integer
- method chown(path as string, uid as Integer, gid as Integer) as Integer
- method error as Integer
- method lstat(path as string) as Integer
- method stat(path as string) as Integer
- property blocks as Double
- property blocksize as Integer
- property dev as Integer
- property flags as Integer
- property gen as Integer
- property gid as Integer
- property ino as Integer
- property mode as Integer
- property nlink as Integer
- property rdev as Integer
- property size as Double
- property uid as Integer
- class DarwinIFStatInterfaceMBS
- class DarwinIFStatMBS
- class DASessionMBS
- method Constructor
- method Eject(disk as DADiskMBS, options as Integer = 0)
- method IsClaimed(disk as DADiskMBS) as boolean
- method Mount(disk as DADiskMBS, path as string, options as Integer = 0)
- method MountWithArguments(disk as DADiskMBS, path as string, arguments() as string, options as Integer = 0)
- method Rename(disk as DADiskMBS, name as string, options as Integer = 0)
- method Unclaim(disk as DADiskMBS)
- method Unmount(disk as DADiskMBS, options as Integer = 0)
- property Handle as Integer
- event Appeared(disk as DADiskMBS)
- event DescriptionChanged(disk as DADiskMBS, keys() as string)
- event Disappeared(disk as DADiskMBS)
- event Ejected(disk as DADiskMBS, dissenter as DADissenterMBS)
- event Mounted(disk as DADiskMBS, dissenter as DADissenterMBS)
- event Peek(disk as DADiskMBS)
- event Renamed(disk as DADiskMBS, dissenter as DADissenterMBS)
- event Unmounted(disk as DADiskMBS, dissenter as DADissenterMBS)
- class DirectorySizeMBS
- class FileListMBS
- method AttributeModificationDate(index as Integer) as Double
- method AttributeModificationDate(index as Integer, UTC as boolean) as Date
- method AttributeModificationDateTime(index as integer, UTC as boolean) as DateTime
- method BackupDate(index as Integer) as Double
- method BackupDate(index as Integer, UTC as boolean) as Date
- method BackupDateTime(index as integer, UTC as boolean) as DateTime
- method CFURL(index as integer) as Variant
- method Close
- method Constructor
- method Constructor(filelist as FileListMBS, index as Integer, WinFilter as string = "", SkipMode as Integer = 0)
- method Constructor(folder as folderitem, WinFilter as string = "", SkipMode as Integer = 0)
- method Constructor(Path as String, WinFilter as string = "", SkipMode as Integer = 0)
- method CreationDate(index as Integer) as Double
- method CreationDate(index as Integer, UTC as boolean) as Date
- method CreationDateTime(index as integer, UTC as boolean) as DateTime
- method Directory(index as Integer) as boolean
- method DisplayName(index as Integer) as string
- method FinderFlags(index as Integer) as Integer
- method IsBundle(index as Integer) as Boolean
- method IsHardLinked(index as Integer) as boolean
- method Item(index as Integer) as folderitem
- method ItemPath(index as Integer) as string
- method LastAccessDate(index as Integer) as Double
- method LastAccessDate(index as Integer, UTC as boolean) as Date
- method LastAccessDateTime(index as integer, UTC as boolean) as DateTime
- method LogicalDataLength(index as Integer) as Int64
- method LogicalResourceLength(index as Integer) as Int64
- method ModificationDate(index as Integer) as Double
- method ModificationDate(index as Integer, UTC as boolean) as Date
- method ModificationDateTime(index as integer, UTC as boolean) as DateTime
- method Name(index as Integer) as string
- method NodeID(index as Integer) as Int64
- method ParentDirectoryID(index as Integer) as Int64
- method PhysicalDataLength(index as Integer) as Int64
- method PhysicalResourceLength(index as Integer) as Int64
- method SortByCreationDate
- method SortByFileName
- method SortByModificationDate
- method TrueItem(index as Integer) as folderitem
- method Visible(index as Integer) as boolean
- method WinFileAttributes(index as Integer) as Integer
- shared property Cancel as Boolean
- property Count as Integer
- property Folder as FolderItem
- property OK as Boolean
- property Path as String
- shared property Threaded as Boolean
- property TotalLogicalDataLength as Int64
- property TotalLogicalResourceLength as Int64
- property TotalPhysicalDataLength as Int64
- property TotalPhysicalResourceLength as Int64
- shared property YieldTicks as Integer
- class FinderSelectionMBS
- class LargeBinaryStreamMBS
- method Allocate(count as int64, flags as Integer) as int64
- method close
- shared method Create(file as folderitem, MacType as string, MacCreator as string) as LargeBinaryStreamMBS
- shared method Create(path as string, MacType as string, MacCreator as string, WinShareMode as Integer = 0) as LargeBinaryStreamMBS
- shared method CreateResStream(file as folderitem, MacType as string, MacCreator as string) as ResStreamMBS
- shared method CreateResStream(path as string, MacType as string, MacCreator as string) as ResStreamMBS
- shared method DeleteDataFork(file as folderitem)
- shared method DeleteResourceFork(file as folderitem)
- method Flush
- method LockFileExclusive as boolean
- shared method Open(file as folderitem, write as Boolean) as LargeBinaryStreamMBS
- shared method Open(path as string, write as Boolean, WinShareMode as Integer = 0) as LargeBinaryStreamMBS
- shared method OpenAsResStream(file as folderitem, write as Boolean) as ResStreamMBS
- shared method OpenAsResStream(path as string, write as Boolean) as ResStreamMBS
- method QueryDiskGeometry(byref Cylinders as Int64, byref MediaType as Integer, byref TracksPerCylinder as Integer, byref SectorsPerTrack as Integer, byref BytesPerSector as Integer) as boolean
- method Read(count as Integer) as string
- method ReadBlock(count as Integer) as memoryblock
- method Readbyte as Integer
- method ReadLong as Integer
- method ReadShort as Integer
- method UnlockFileExclusive as boolean
- shared method WinCreateStream(file as folderitem, StreamName as String, WinShareMode as Integer = 0) as LargeBinaryStreamMBS
- shared method WinDeleteStream(file as folderitem, StreamName as String) as boolean
- shared method WinOpenStream(file as folderitem, StreamName as String, write as Boolean, WinShareMode as Integer = 0) as LargeBinaryStreamMBS
- method Write(data as string)
- method WriteBlock(data as memoryblock,count as Integer)
- method WriteByte(data as Integer)
- method WriteLong(data as Integer)
- method WriteShort(data as Integer)
- property CanWrite as boolean
- property EOF as boolean
- property Lasterror as Integer
- property Length as Int64
- property LittleEndian as boolean
- property Position as Int64
- property Yield as Boolean
- class MacFileOperationMBS
- method Cancel
- method CopyObject(Item as folderitem, DestinationFolder as folderitem, DestinationName as string, Options as Integer, statusChangeInterval as Double)
- shared method CopyObjectSync(SourceItem as folderitem, DestinationFolder as folderitem, DestinationName as string, byref Result as folderitem, Options as Integer) as Integer
- method MoveObject(Item as folderitem, DestinationFolder as folderitem, DestinationName as string, Options as Integer, statusChangeInterval as Double)
- shared method MoveObjectSync(SourceItem as folderitem, DestinationFolder as folderitem, DestinationName as string, byref Result as folderitem, Options as Integer) as Integer
- method MoveObjectToTrash(Item as folderitem, Options as Integer, statusChangeInterval as Double)
- shared method MoveObjectToTrashSync(SourceItem as folderitem, byref Result as folderitem, Options as Integer) as Integer
- method Status as MacFileOperationStatusMBS
- property Handle as Integer
- property LastError as Integer
- event StatusChanged(status as MacFileOperationStatusMBS)
- class MacFileOperationStatusMBS
- class MacQuarantinePropertiesMBS
- class NetFSMountMBS
- method Cancel
- method MountURLAsync(URL as String, MountPath as String = "", User as String = "", Password as String = "", OpenOptions as Dictionary = nil, MountOptions as Dictionary = nil) as Integer
- method MountURLSync(URL as String, MountPath as String = "", User as String = "", Password as String = "", OpenOptions as Dictionary = nil, MountOptions as Dictionary = nil, byref MountPoints() as String) as Integer
- shared method URLForRemountingVolume(path as String) as String
- shared method URLForRemountingVolume(vol as FolderItem) as String
- shared method URLProbe(hostname as String) as String
- property Handle as Integer
- property Lasterror as Integer
- event MountURLAsyncCompleted(status as Integer, URL as String, mountpoints() as String)
- class PermissionsMBS
- class ResourceForkMBS
- method AddResource(Data as Memoryblock, ResourceType as String, ID as Integer, Name as String)
- method AddResource(Data as String, ResourceType as String, ID as Integer, Name as String)
- method Close
- method Constructor
- shared method Create(file as folderitem, UseDataFork as boolean = false) as ResourceForkMBS
- method GetIndResource(ResourceType as String, index as Integer) As String
- method GetNamedResource(ResourceType as String, Name as String) As String
- method GetResource(ResourceType as String, ID as Integer) As String
- method GetResourceMemory(ResourceType as String, ID as Integer) As Memoryblock
- shared method Open(file as folderitem, Write as boolean, UseDataFork as boolean = false) as ResourceForkMBS
- method RemoveResource(ResourceType as String, ID as Integer)
- method ResourceCount(ResourceType as String) as Integer
- method ResourceID(ResourceType as String, index as Integer) as Integer
- method ResourceName(ResourceType as String, index as Integer) As String
- method ResourceSizeOnDisk(ResourceType as String, ID as Integer) as Integer
- method ResourceType(index as Integer) As String
- method UniqueID(ResourceType as String) as Integer
- property Handle as Integer
- property LastError as Integer
- property Modified as Boolean
- property TypeCount as Integer
- property Writable as Boolean
- property ResourceAttributes(ResourceType as String, ID as Integer) as Integer
- property ResourceLocked(ResourceType as String, ID as Integer) as boolean
- property ResourcePreload(ResourceType as String, ID as Integer) as boolean
- property ResourceProtected(ResourceType as String, ID as Integer) as boolean
- property ResourcePurgeable(ResourceType as String, ID as Integer) as boolean
- property ResourceSysHeap(ResourceType as String, ID as Integer) as boolean
- class ResStreamMBS
- class StdinMBS
- shared method AttachConsole(ProcessID as Integer = -1) as Integer
- shared method Flush
- shared method FreeConsole as Integer
- shared method GetCharacter as Integer
- shared method Read(count as Integer) as string
- shared method ReadDouble(byref value as Double) as Integer
- shared method ReadInteger(byref value as Integer) as Integer
- shared method ReadString(byref value as string) as Integer
- shared property Echo as Boolean
- shared property IsReady as boolean
- class StdoutMBS
- class VolumeInformationMBS
- class WindowsDiskChangeMBS
- class WindowsDriveNotificationMBS
- class WindowsVolumeInformationMBS
- Class Extensions
- class FolderItem
- method AbsolutePath as string
- method AbsolutePathMBS as string
- method BackupIsItemExcludedMBS(byref excludeByPath as boolean) as boolean
- method BackupSetItemExcludedMBS(exclude as boolean, excludeByPath as boolean) as Integer
- method CalculateDirectorySizeMBS(recursive as boolean = false, ticks as Integer = 0, QueryCompressedSizes as boolean = false, RecursionLimit as Integer = -1) as DirectorySizeMBS
- method CompressedFileLengthMBS as int64
- method CreateLargeBinaryStreamMBS(MacType as string, MacCreator as string) as LargeBinaryStreamMBS
- method CreateResStreamMBS(MacType as string, MacCreator as string) as ResStreamMBS
- method CreatorAppMBS as FolderItem
- method CreatorAppMBS(creatorCode as String) as FolderItem
- method DarwinMediaClassMBS as string
- method DarwinMediaInfoMBS as CFDictionaryMBS
- method DarwinVolumeNameMBS as string
- method DeleteDataForkMBS
- method DeleteResourceForkMBS
- method DisplayPathMBS(delimiter as string = "/") as string
- method EjectVolumeMBS(force as boolean, byref dissenterPID as Integer) as Integer
- method FilesMBS as FolderItem()
- method FlushVolumeMBS as Integer
- method FoldersMBS as FolderItem()
- method GetFileFlagsMBS as Integer
- method GetFolderFlagsMBS as Integer
- method GetVolumeRefMBS as Integer
- method IsCompressedFileMBS as Boolean
- method IsEjectableVolumeMBS as Boolean
- method IsEncryptedFileMBS as Boolean
- method IsFileDataForkOpenReadWriteMBS as boolean
- method IsFileResourceForkOpenReadWriteMBS as boolean
- method IsOnRemoteVolumeMBS as Boolean
- method ItemsMBS as FolderItem()
- method KindMBS as string
- method LaunchMBS(inFront as Boolean) as Boolean
- method LogicalFileDataLengthMBS as int64
- method LogicalFileResLengthMBS as int64
- method LogicalFileTotalLengthMBS as int64
- method LongPathMBS as string
- method MacCopyObjectMBS(DestinationFolder as folderitem, DestinationName as string, byref Result as folderitem, Options as Integer) as Integer
- method MacIsHardLinkedMBS as boolean
- method MacMoveObjectMBS(DestinationFolder as folderitem, DestinationName as string, byref Result as folderitem, Options as Integer) as Integer
- method MacMoveObjectToTrashMBS(byref Result as folderitem, Options as Integer) as Integer
- method MacNodeIDMBS as UInt64
- method MacParentDirectoryIDMBS as UInt64
- method MacResolveNodeIDMBS(NodeID as UInt64) as folderitem
- method NameExtensionMBS as string
- method NameWithoutExtensionMBS as string
- method NativePath as string
- method OpenAsLargeBinaryStreamMBS(write as Boolean) as LargeBinaryStreamMBS
- method OpenAsResStreamMBS(write as Boolean) as ResStreamMBS
- method OpenWithAppMBS(TheApplication as FolderItem, inFront as Boolean) as Boolean
- method ParentVolumeMBS as folderitem
- method PermissionsMBS(OldWay as boolean) as PermissionsMBS
- method PhysicalFileDataLengthMBS as int64
- method PhysicalFileResLengthMBS as int64
- method PhysicalFileTotalLengthMBS as int64
- method ReadFileMBS(byref data as MemoryBlock, offset As Integer = 0, byteCount As Integer = -1) as boolean
- method ReadFileMBS(byref data as string, offset As Integer = 0, byteCount As Integer = -1) as boolean
- method SetFileFlagsMBS(flags as Integer) as Integer
- method SetFolderFlagsMBS(flags as Integer) as Integer
- method SetTagNamesMBS(tags() as string) as Integer
- method SetTagNamesMBS(tags() as string, byref e as CFErrorMBS) as Integer
- method ShortPathMBS as string
- method SortedFilesMBS(followAlias as Boolean = false, SortByDisplayName as boolean = false, VisibleOnly as boolean = false) as FolderItem()
- method SortedFoldersMBS(followAlias as Boolean = false, SortByDisplayName as boolean = false, VisibleOnly as boolean = false) as FolderItem()
- method SortedItemsMBS(followAlias as Boolean = false, SortByDisplayName as boolean = false, VisibleOnly as boolean = false) as FolderItem()
- method TagNamesMBS as string()
- method TagNamesMBS(byref e as CFErrorMBS) as string()
- method TrueFilesMBS as FolderItem()
- method TrueFoldersMBS as FolderItem()
- method TrueItemsMBS as FolderItem()
- method UnixpathMBS as string
- method UnMountVolumeMBS(force as boolean = false) as Integer
- method UnMountVolumeMBS(force as boolean, byref dissenterPID as Integer) as Integer
- method VolGetFolderItemIDMBS(createFileIDs as Boolean = true) as Integer
- method VolumeFreeSizeMBS as Int64
- method VolumeInformationMBS as VolumeInformationMBS
- method VolumeSizeMBS as Int64
- method VolumeSupportsHugeFilesMBS as Integer
- method VolumeUUIDMBS as string
- method WinThumbnailMBS(preferredSize as Integer = 512) as picture
- method WriteFileMBS(data as MemoryBlock) as boolean
- method WriteFileMBS(data as string) as boolean
- Modules
- module ExtendedAttributesMBS
- 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
- const kAttributeNameFinderComment = "com.apple.metadata:kMDItemFinderComment"
- const kAttributeNameFinderInfo = "com.apple.FinderInfo"
- const kAttributeNameResourceFork = "com.apple.ResourceFork"
- module WindowsJunctionMBS
- Blog Entries
Release notes
- Version 22.5
- Version 22.4
- Version 21.5
- Version 21.2
- Fixed a memory leak in FileListMBS class for Windows.
- Fixed a problem with TrueItem() function in FileListMBS not working right for alias files.
- Version 21.0
- Deprecated HFSUniStr255 and FSRef for FileListMBS class.
- Version 20.5
- Added Windows support for isReady property in StdInMBS class.
- Version 20.3
- Version 20.1
- Added SkipMode parameter to constructors for FileListMBS class to skip over files/folders and hidden items.
- Fixed FileListMBS to not report logical file sizes correctly for newer Mac implementation.
- Version 19.5
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, MBS Win Plugin.