Difference between revisions of "Unit Filesystem"
From Ultibo.org
Line 1,356: | Line 1,356: | ||
<br /> | <br /> | ||
− | '''RTL | + | '''RTL FileSystem functions''' |
'''System file functions''' | '''System file functions''' |
Revision as of 05:04, 20 October 2016
Return to Unit Reference
Contents
[hide]Description
To be documented
Constants
To be documented
Type definitions
To be documented
Public variables
To be documented
Function declarations
Initialization functions
FileSystem functions (Delphi / FreePascal RTL Equivalent)
Drive functions
[Expand]
function FSSetDriveLabel(ADrive:Byte; const ALabel:String):Boolean; inline;
Description: To be documented
[Expand]
function FSSetDriveSerial(ADrive:Byte; ASerial:LongWord):Boolean; inline;
Description: To be documented
[Expand]
function FSSetCurrentDrive(const ADrive:String):Boolean; inline;
Description: To be documented
File functions
[Expand]
function FSFileOpen(const AFileName:String; AMode:Integer):Integer; inline;
Description: To be documented
[Expand]
function FSFileCreate(const AFileName:String):Integer; inline;
Description: To be documented
[Expand]
function FSDeleteFile(const AFileName:String):Boolean; inline;
Description: To be documented
[Expand]
function FSRenameFile(const AOldName,ANewName:String):Boolean; inline;
Description: To be documented
[Expand]
function FSFileSeek(AHandle,AOffset,AOrigin:Integer):Integer; inline;
Description: To be documented
[Expand]
function FSFileExists(const AFileName:String):Boolean; inline;
Description: To be documented
[Expand]
function FSFileGetAttr(const AFileName:String):Integer; inline;
Description: To be documented
[Expand]
function FSFileSetAttr(const AFileName:String; AAttr:Integer):Integer; inline;
Description: To be documented
[Expand]
function FSFileSetDate(AHandle:Integer; AAge:Integer):Integer; inline;
Description: To be documented
[Expand]
function FSFileRead(AHandle:Integer; var ABuffer; ACount:Integer):Integer; inline;
Description: To be documented
[Expand]
function FSFileWrite(AHandle:Integer; const ABuffer; ACount:Integer):Integer; inline;
Description: To be documented
Directory functions
[Expand]
function FSRenameDir(const AOldName,ANewName:String):Boolean; inline;
Description: To be documented
[Expand]
function FSSetCurrentDir(const ADirName:String):Boolean; inline;
Description: To be documented
[Expand]
function FSDirectoryExists(const ADirName:String):Boolean; inline;
Description: To be documented
Search functions
[Expand]
function FSFindFirst(const APath:String; AAttr:Integer; var ASearchRec:TSearchRec):Integer; inline;
Description: To be documented
[Expand]
function FSFindNext(var ASearchRec:TSearchRec):Integer; inline;
Description: To be documented
Additional functions
[Expand]
function FSFileCopy(const ASourceFile,ADestFile:String; AFailIfExists:Boolean):Boolean; inline;
Description: To be documented
[Expand]
function FSFileCopyEx(const ASourceFile,ADestFile:String; AFailIfExists:Boolean; AUseSourceDate:Boolean; ADestDate:Integer; AUseSourceAttr:Boolean; ADestAttr:Integer):Boolean; inline;
Description: To be documented
[Expand]
function FSGetShortName(const AFileName:String):String; inline;
Description: To be documented
[Expand]
function FSGetLongName(const AFileName:String):String; inline;
Description: To be documented
[Expand]
function FSGetTrueName(const AFileName:String):String; inline;
Description: To be documented
Extended functions
[Expand]
function FSFileSeekEx(AHandle:Integer; const AOffset:Int64; AOrigin:Integer):Int64; inline;
Description: To be documented
[Expand]
function FSFileAgeEx(const AFileName:String):TFileTime; inline;
Description: To be documented
[Expand]
function FSFileSetDateEx(AHandle:Integer; AAge:TFileTime):Integer; inline;
Description: To be documented
[Expand]
function FSGetFileTime(AHandle:Integer; ACreateTime,AAccessTime,AWriteTime:PFileTime):Boolean; inline;
Description: To be documented
[Expand]
function FSSetFileTime(AHandle:Integer; ACreateTime,AAccessTime,AWriteTime:PFileTime):Boolean; inline;
Description: To be documented
[Expand]
function FSFindFirstEx(const APath:String; var ASearchRec:TFileSearchRec):Integer; inline;
Description: To be documented
[Expand]
function FSFindNextEx(var ASearchRec:TFileSearchRec):Integer; inline;
Description: To be documented
[Expand]
procedure FSFindCloseEx(var ASearchRec:TFileSearchRec); inline;
Description: To be documented
FileSystem functions (Win32 Compatibility)
Drive functions
[Expand]
function FSDefineDosDevice(const ADeviceName,ATargetPath:String; AFlags:LongWord):Boolean; inline;
Description: To be documented
[Expand]
function FSGetDiskType(const ARootPath:String):LongWord; inline;
Description: Equivalent to Win32 GetDriveType
[Expand]
function FSGetDiskFreeSpace(const ARootPath:String; var ASectorsPerCluster,ABytesPerSector,ANumberOfFreeClusters,ATotalNumberOfClusters:LongWord):Boolean; inline;
Description: To be documented
[Expand]
function FSGetDiskFreeSpaceEx(const APathName:String; var AFreeBytesAvailableToCaller,ATotalNumberOfBytes,ATotalNumberOfFreeBytes:Int64):Boolean; inline;
Description: To be documented
[Expand]
function FSGetVolumeInformation(const ARootPath:String; var AVolumeName:String; var AVolumeSerialNumber,AMaximumComponentLength,AFileSystemFlags:LongWord; var ASystemName:String):Boolean; inline;
Description: To be documented
[Expand]
function FSQueryDosDevice(const ARootPath:String):String; inline;
Description: To be documented
[Expand]
function FSSetVolumeLabel(const AVolume:String; const ALabel:String):Boolean; inline;
Description: To be documented
File functions
[Expand]
function FSCloseFile(AHandle:THandle):Boolean; inline;
Description: Equivalent to Win32 CloseHandle
[Expand]
function FSCopyFile(const AExistingName,ANewName:String; AFailIfExists:Boolean):Boolean; inline;
Description: To be documented
[Expand]
function FSCreateFile(const AFileName:String; AAccessMode,AShareMode,ACreateFlags,AFileAttributes:LongWord):THandle; inline;
Description: To be documented
[Expand]
function FSFindCloseFile(AHandle:THandle):Boolean; inline;
Description: Equivalent to Win32 FindClose
[Expand]
function FSFindFirstFile(const AFileName:String; var AFindData:TWin32FindData):THandle; inline;
Description: To be documented
[Expand]
function FSFindNextFile(AHandle:THandle; var AFindData:TWin32FindData):Boolean; inline;
Description: To be documented
[Expand]
function FSFlushFileBuffers(AHandle:THandle):Boolean; inline;
Description: To be documented
[Expand]
function FSGetFileAttributes(const AFileName:String):LongWord; inline;
Description: To be documented
[Expand]
function FSGetFileSize(AHandle:THandle; var AFileSizeHigh:LongWord):LongWord; inline;
Description: To be documented
[Expand]
function FSGetFullPathName(const AFileName:String):String; inline;
Description: To be documented
[Expand]
function FSGetShortPathName(const ALongPath:String):String; inline;
Description: To be documented
[Expand]
function FSMoveFile(const AExistingName,ANewName:String):Boolean; inline;
Description: To be documented
[Expand]
function FSReadFile(AHandle:THandle; var ABuffer; ABytesToRead:LongWord; var ABytesRead:LongWord):Boolean; inline;
Description: To be documented
[Expand]
function FSSetFileAttributes(const AFileName:String; AFileAttributes:LongWord):Boolean; inline;
Description: To be documented
[Expand]
function FSSetFilePointer(AHandle:THandle; ADistanceToMove:LongWord; var ADistanceToMoveHigh:LongWord; AMoveMethod:LongWord):LongWord; inline;
Description: To be documented
[Expand]
function FSSetFilePointerEx(AHandle:THandle; const ADistanceToMove:Int64; var ANewFilePointer:Int64; AMoveMethod:LongWord):Boolean; inline;
Description: To be documented
[Expand]
function FSWriteFile(AHandle:THandle;const ABuffer; ABytesToWrite:LongWord; var ABytesWritten:LongWord):Boolean; inline;
Description: To be documented
[Expand]
function FSGetLongPathName(const AShortPath:String):String; inline;
Description: To be documented
[Expand]
function FSSetFileShortName(const AFileName,AShortName:String):Boolean;
Description: To be documented
[Expand]
function FSSetFileShortNameEx(AHandle:Integer; const AShortName:String):Boolean;
Description: To be documented
[Expand]
function FSCreateHardLink(const ALinkName,AFileName:String):Boolean;
Description: To be documented
[Expand]
function FSCreateSymbolicLink(const ALinkName,ATargetName:String; ADirectory:Boolean):Boolean;
Description: To be documented
Directory functions
[Expand]
function FSCreateDirectory(const APathName:String):Boolean; inline;
Description: To be documented
[Expand]
function FSRemoveDirectory(const APathName:String):Boolean; inline;
Description: To be documented
[Expand]
function FSSetCurrentDirectory(const APathName:String):Boolean; inline;
Description: To be documented
RTL FileSystem functions
System file functions
[Expand]
procedure SystemDoRename(Name1,Name2:PChar; Name1Changeable,Name2Changeable:Boolean);
Description: To be documented
[Expand]
function SystemDoWrite(Handle:LongInt; Address:Pointer; Len:LongInt):LongInt;
Description: To be documented
[Expand]
function SystemDoRead(Handle:LongInt; Address:Pointer; Len:LongInt):LongInt;
Description: To be documented
[Expand]
procedure SystemDoOpen(var F; Name:PFileTextRecChar; Flags:LongInt; NameChangeable:Boolean);
Description: To be documented
Return to Unit Reference