Unit xomFileSystem

Description

 

Overview

Classes, Interfaces, Objects and Records

Name Description
Record TXOMSearchRec  
Interface IxomFileDialog  
Class TxomFileDialog  
Class TxomBaseFileSystem  
Class TxomBaseFileSystems  
Class TxomDiskSearchRec  
Class TxomDiskFileSystem  
Class TxomRFSFileSystem  
Class TxomAbstractFileHandle  
Class TxomAbstractFileHandles  
Class TxomAbstractVolume  
Class TxomAbstractVolumes  
Class TxomAbstractFileSystem  

Functions and Procedures

procedure xomFileSystem_initialization;
procedure xomFileSystem_finalization;
function xomFileSystems: TxomBaseFileSystems;
function ActiveFileSystem: TxomBaseFileSystem;
function FileSystemFor(const APathName: WideString): TxomBaseFileSystem;
function WideCreateOpenDialog(AOwner: TComponent): IxomFileDialog;
function WideCreateSaveDialog(AOwner: TComponent): IxomFileDialog;
function WideCreateSelectDirectoryDialog(AOwner: TComponent): TLCLComponent;
function WideActiveFileSystem: WideString;
function WideAppDataDir: WideString;
function WideApplicationDir: WideString;
function WideOSDesktopDir: WideString;
function WideOSTempDir: WideString;
function WideOSDir: WideString;
function WideOSSystemDir: WideString;
function WideOSPicturesDir: WideString;
function WideOSDocumentsDir: WideString;
function WideOSDownloadsDir: WideString;
function WideOSCacheDir: WideString;
function WideOSProgramsDir: WideString;
function WideOSSendToDir: WideString;
function WideOSHomeDir: WideString;
function WideIncludeTrailingBackslash(const S: WideString): WideString;
function WideExcludeTrailingBackslash(const S: WideString): WideString;
function WideSelectDirectory(const ACaption, AInitialDirectory: WideString; var ADirectory: WideString): Boolean;
function WideSelectFile(const ACaption, AInitialDir, AFilter: WideString; AAllowMultiSelect: Boolean; var AFileName: WideString): Boolean;
function WideFileExists(const AFileName: WideString): Boolean;
function WideHashStringForFile(const AFileName: WideString): AnsiString;
function WideFileOpen (const AFileName : WideString; Mode: Integer): System.THandle;
function WideFileCreate (const AFileName : WideString; ShareMode: Integer; Rights: Integer) : System.THandle;
function WideFileRead (Handle : THandle; out Buffer; Count : longint) : Longint;
function WideFileWrite (Handle : THandle; const Buffer; Count : Longint) : Longint;
function WideFileSeek (Handle : THandle; FOffset: Int64; Origin: Longint) : Int64;
function WideFileTruncate (Handle : THandle; Size: Int64): Boolean;
procedure WideFileClose (AHandle: THandle);
function WideFileGetAttr(const AFileName: WideString): Longint;
function WideFileSetAttr(const AFileName: WideString; AAttr: Longint): Longint;
function WideFileSetDate (const FileName: WideString; Age: Integer): Integer;
function WideExpandFileName (const FileName: WideString): WideString;
function WideCopyFile (const FromFile, ToFile: WideString; FailIfExists: Boolean): Boolean;
function WideMoveFile (const FromFile, ToFile: WideString): Boolean;
function WideMoveDir (const FromDir, ToDir: WideString): Boolean;
function WideRemoveDir (const ADir: WideString; AWithContent: Boolean): Boolean;
function WideIsDirEmpty(const ADir: WideString): Boolean;
function WideDeleteFile(const FileName: WideString): Boolean;
function WideRenameFile(const OldName, NewName: WideString): Boolean;
function WideRenameDir(const OldName, NewName: WideString): Boolean;
function WideExtractFileExt(const FileName: WideString): WideString;
function WideFileSetReadOnly (const FileName: WideString; ReadOnly: Boolean): Boolean;
function WideDirectoryExists(const AName: WideString): Boolean;
function WideDirectoryIsPackage(ADir: WideString): Boolean;
function WideChangeFileExt(const FileName, Extension: WideString): WideString;
function WideExtractRelativePath(const BaseName, DestName: WideString): WideString;
function WideExtractFileName(const FileName: WideString): WideString;
function WideExtractFileNameOnly(const FileName: WideString): WideString;
function WideExtractFilePath(const FileName: WideString): WideString;
function WideExtractFileDir(const FileName: WideString): WideString;
function WideExtractFileDrive(const FileName: WideString): WideString;
function WideGetCurrentDir: WideString;
function WideSetCurrentDir(const Dir: WideString): Boolean;
function WideForceDirectories(const Dir: WideString): Boolean;
function WideFindFirst(const Path: WideString; Attr: Integer; var F: TXOMSearchRec): Integer;
function WideFindNext(var F: TXOMSearchRec): Integer;
procedure WideFindClose(var F: TXOMSearchRec);
function WideFileAge(const FileName: WideString): Integer;
function WideFileIsReadOnly(const FileName: WideString): Boolean;
function WideFileIsReadable(const FileName: WideString): Boolean;
function WideFileIsWritable(const FileName: WideString): Boolean;
function WideDirectoryIsWritable(const AName: WideString): Boolean;
function WideExtractShortPathName(const FileName: WideString): WideString;
function WideMatchesMask (const FileName: WideString; const Mask: WideString): Boolean;
function WideSearchFiles (const ADir: WideString; const AMask: WideString; const AFrom: TDateTime; AResult: TxomStrings; const ARecursive: Boolean = True; const ADateCheckKind: TDateCheckKind = dckModified; const MaxResults: Integer = -1; AFiltered: TxomStrings = nil): Boolean;
function WideSearchFilesExtended (const ADir: WideString; const AMask: WideString; const AFrom: TDateTime; AResult: TxomStrings; AWithSearchRecs: Boolean; var ASearchRecs: TXOMSearchRecs; const ARecursive: Boolean = True; const ADateCheckKind: TDateCheckKind = dckModified; const MaxResults: Integer = -1; AFiltered: TxomStrings = nil): Boolean;
function WideSearchFolders (const ADir: WideString; const AMask: WideString; AResult: TxomStrings; ARecursive: Boolean): Boolean;
function WideDownloadFile(const AFile, ALocalFile: WideString): Boolean;
function WideDownloadFileStream(const AFile: WideString; AStream: TStream): Boolean;
function WideDiffDownloadFile(const ALocalFile, AFile: WideString): Boolean;
function WideDiffDownloadFileStream(const AFile: WideString; AStream: TStream): Boolean;
function WideUploadFile(const ALocalFile, AFile: WideString): Boolean;
function WideUploadFileStream(const AFile: WideString; AStream: TStream): Boolean;
function WideDiffUploadFile(const ALocalFile, AFile: WideString): Boolean;
function WideDiffUploadFileStream(const AFile: WideString; AStream: TStream): Boolean;
function WideLoadExif(const AFileName: WideString; AStream: TStream): Boolean;
function WideSaveExif(const AFileName: WideString; AStream: TStream): Boolean;

Types

TxomFileSystemSpecialFolder = (...);
TxomFileSystemSpecialFolders = set of TxomFileSystemSpecialFolder;
TXOMSearchRecs = Array of TXOMSearchRec;
TxomBaseFileSystemClass = class of TxomBaseFileSystem;
TxomAbstractVolumeAttribute = (...);
TxomAbstractVolumeAttributes = set of TxomAbstractVolumeAttribute;
TxomFileSystemEvent = procedure(AFileSystem: TxomBaseFileSystem);

Constants

IxomFileDialogGUID = '{90FA7B4A-758F-4FA0-BB4D-86A71AE365C8}';

Variables

xomFileSystemCreatedEvent: TxomFileSystemEvent = nil;

Description

Functions and Procedures

procedure xomFileSystem_initialization;
 
procedure xomFileSystem_finalization;
 
function xomFileSystems: TxomBaseFileSystems;
 
function ActiveFileSystem: TxomBaseFileSystem;
 
function FileSystemFor(const APathName: WideString): TxomBaseFileSystem;
 
function WideCreateOpenDialog(AOwner: TComponent): IxomFileDialog;
 
function WideCreateSaveDialog(AOwner: TComponent): IxomFileDialog;
 
function WideCreateSelectDirectoryDialog(AOwner: TComponent): TLCLComponent;
 
function WideActiveFileSystem: WideString;
 
function WideAppDataDir: WideString;
 
function WideApplicationDir: WideString;
 
function WideOSDesktopDir: WideString;
 
function WideOSTempDir: WideString;
 
function WideOSDir: WideString;
 
function WideOSSystemDir: WideString;
 
function WideOSPicturesDir: WideString;
 
function WideOSDocumentsDir: WideString;
 
function WideOSDownloadsDir: WideString;
 
function WideOSCacheDir: WideString;
 
function WideOSProgramsDir: WideString;
 
function WideOSSendToDir: WideString;
 
function WideOSHomeDir: WideString;
 
function WideIncludeTrailingBackslash(const S: WideString): WideString;
 
function WideExcludeTrailingBackslash(const S: WideString): WideString;
 
function WideSelectDirectory(const ACaption, AInitialDirectory: WideString; var ADirectory: WideString): Boolean;
 
function WideSelectFile(const ACaption, AInitialDir, AFilter: WideString; AAllowMultiSelect: Boolean; var AFileName: WideString): Boolean;
 
function WideFileExists(const AFileName: WideString): Boolean;
 
function WideHashStringForFile(const AFileName: WideString): AnsiString;
 
function WideFileOpen (const AFileName : WideString; Mode: Integer): System.THandle;
 
function WideFileCreate (const AFileName : WideString; ShareMode: Integer; Rights: Integer) : System.THandle;
 
function WideFileRead (Handle : THandle; out Buffer; Count : longint) : Longint;
 
function WideFileWrite (Handle : THandle; const Buffer; Count : Longint) : Longint;
 
function WideFileSeek (Handle : THandle; FOffset: Int64; Origin: Longint) : Int64;
 
function WideFileTruncate (Handle : THandle; Size: Int64): Boolean;
 
procedure WideFileClose (AHandle: THandle);
 
function WideFileGetAttr(const AFileName: WideString): Longint;
 
function WideFileSetAttr(const AFileName: WideString; AAttr: Longint): Longint;
 
function WideFileSetDate (const FileName: WideString; Age: Integer): Integer;
 
function WideExpandFileName (const FileName: WideString): WideString;
 
function WideCopyFile (const FromFile, ToFile: WideString; FailIfExists: Boolean): Boolean;
 
function WideMoveFile (const FromFile, ToFile: WideString): Boolean;
 
function WideMoveDir (const FromDir, ToDir: WideString): Boolean;
 
function WideRemoveDir (const ADir: WideString; AWithContent: Boolean): Boolean;
 
function WideIsDirEmpty(const ADir: WideString): Boolean;
 
function WideDeleteFile(const FileName: WideString): Boolean;
 
function WideRenameFile(const OldName, NewName: WideString): Boolean;
 
function WideRenameDir(const OldName, NewName: WideString): Boolean;
 
function WideExtractFileExt(const FileName: WideString): WideString;
 
function WideFileSetReadOnly (const FileName: WideString; ReadOnly: Boolean): Boolean;
 
function WideDirectoryExists(const AName: WideString): Boolean;
 
function WideDirectoryIsPackage(ADir: WideString): Boolean;
 
function WideChangeFileExt(const FileName, Extension: WideString): WideString;
 
function WideExtractRelativePath(const BaseName, DestName: WideString): WideString;
 
function WideExtractFileName(const FileName: WideString): WideString;
 
function WideExtractFileNameOnly(const FileName: WideString): WideString;
 
function WideExtractFilePath(const FileName: WideString): WideString;
 
function WideExtractFileDir(const FileName: WideString): WideString;
 
function WideExtractFileDrive(const FileName: WideString): WideString;
 
function WideGetCurrentDir: WideString;
 
function WideSetCurrentDir(const Dir: WideString): Boolean;
 
function WideForceDirectories(const Dir: WideString): Boolean;
 
function WideFindFirst(const Path: WideString; Attr: Integer; var F: TXOMSearchRec): Integer;
 
function WideFindNext(var F: TXOMSearchRec): Integer;
 
procedure WideFindClose(var F: TXOMSearchRec);
 
function WideFileAge(const FileName: WideString): Integer;
 
function WideFileIsReadOnly(const FileName: WideString): Boolean;
 
function WideFileIsReadable(const FileName: WideString): Boolean;
 
function WideFileIsWritable(const FileName: WideString): Boolean;
 
function WideDirectoryIsWritable(const AName: WideString): Boolean;
 
function WideExtractShortPathName(const FileName: WideString): WideString;
 
function WideMatchesMask (const FileName: WideString; const Mask: WideString): Boolean;
 
function WideSearchFiles (const ADir: WideString; const AMask: WideString; const AFrom: TDateTime; AResult: TxomStrings; const ARecursive: Boolean = True; const ADateCheckKind: TDateCheckKind = dckModified; const MaxResults: Integer = -1; AFiltered: TxomStrings = nil): Boolean;
 
function WideSearchFilesExtended (const ADir: WideString; const AMask: WideString; const AFrom: TDateTime; AResult: TxomStrings; AWithSearchRecs: Boolean; var ASearchRecs: TXOMSearchRecs; const ARecursive: Boolean = True; const ADateCheckKind: TDateCheckKind = dckModified; const MaxResults: Integer = -1; AFiltered: TxomStrings = nil): Boolean;
 
function WideSearchFolders (const ADir: WideString; const AMask: WideString; AResult: TxomStrings; ARecursive: Boolean): Boolean;
 
function WideDownloadFile(const AFile, ALocalFile: WideString): Boolean;
 
function WideDownloadFileStream(const AFile: WideString; AStream: TStream): Boolean;
 
function WideDiffDownloadFile(const ALocalFile, AFile: WideString): Boolean;
 
function WideDiffDownloadFileStream(const AFile: WideString; AStream: TStream): Boolean;
 
function WideUploadFile(const ALocalFile, AFile: WideString): Boolean;
 
function WideUploadFileStream(const AFile: WideString; AStream: TStream): Boolean;
 
function WideDiffUploadFile(const ALocalFile, AFile: WideString): Boolean;
 
function WideDiffUploadFileStream(const AFile: WideString; AStream: TStream): Boolean;
 
function WideLoadExif(const AFileName: WideString; AStream: TStream): Boolean;
 
function WideSaveExif(const AFileName: WideString; AStream: TStream): Boolean;
 

Types

TxomFileSystemSpecialFolder = (...);
 
Values
  • xsfApplicationDir
  • xsfAppDataDir
  • xsfOSDesktopDir
  • xsfOSTempDir
  • xsfOSDir
  • xsfOSSystemDir
  • xsfOSDocumentsDir
  • xsfOSPicturesDir
  • xsfOSDownloadsDir
  • xsfOSCacheDir
  • xsfOSProgramsDir
  • xsfOSSendToDir
  • xsfOSHomeDir
TxomFileSystemSpecialFolders = set of TxomFileSystemSpecialFolder;
 
TXOMSearchRecs = Array of TXOMSearchRec;
 
TxomBaseFileSystemClass = class of TxomBaseFileSystem;
 
TxomAbstractVolumeAttribute = (...);
 
Values
  • vaRead
  • vaWrite
  • vaHidden
TxomAbstractVolumeAttributes = set of TxomAbstractVolumeAttribute;
 
TxomFileSystemEvent = procedure(AFileSystem: TxomBaseFileSystem);
 

Constants

IxomFileDialogGUID = '{90FA7B4A-758F-4FA0-BB4D-86A71AE365C8}';
 

Variables

xomFileSystemCreatedEvent: TxomFileSystemEvent = nil;
 

Generated by PasDoc 0.15.0.