Difference between revisions of "TFileSystem"

From Ultibo.org
Jump to: navigation, search
(Created page with "Return to Unit Filesystem __TOC__ === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible...")
 
 
(4 intermediate revisions by the same user not shown)
Line 89: Line 89:
 
|-
 
|-
 
| <code>FSymbolicLinkTag:LongWord;</code>
 
| <code>FSymbolicLinkTag:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FMinFileTime:TFileTime;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 126: Line 129:
 
| <code>FCurrentIndex:LongWord;</code>
 
| <code>FCurrentIndex:LongWord;</code>
 
| TLS Index for storing current directory
 
| TLS Index for storing current directory
 +
|-
 +
| <code>FCurrentEntry:TDiskEntry;</code>
 +
| Current directory when global current directory is enabled
 
|-
 
|-
 
|colspan="2"|&nbsp;
 
|colspan="2"|&nbsp;
Line 373: Line 379:
 
|-
 
|-
 
| <code>function LoadSymbolicLinkTag:LongWord; virtual;</code>
 
| <code>function LoadSymbolicLinkTag:LongWord; virtual;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function LoadMinFileTime:TFileTime; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 729: Line 738:
 
|-
 
|-
 
| <code>property SymbolicLinkTag:LongWord read FSymbolicLinkTag;</code>
 
| <code>property SymbolicLinkTag:LongWord read FSymbolicLinkTag;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property MinFileTime:TFileTime read FMinFileTime;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 873: Line 885:
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
−
| <code>procedure FileClose(Handle:Integer); virtual;</code>
+
| <code>procedure FileClose(Handle:THandle); virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 885: Line 897:
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
−
| <code>function FileFlush(Handle:Integer):Boolean; virtual;</code>
+
| <code>function FileFlush(Handle:THandle):Boolean; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
−
| <code>function FileTruncate(Handle:Integer):Boolean; virtual;</code>
+
| <code>function FileTruncate(Handle:THandle):Boolean; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 904: Line 916:
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
−
| <code>function FileGetDate(Handle:Integer):Integer; virtual;</code>
+
| <code>function FileGetDate(Handle:THandle):Integer; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 916: Line 928:
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
−
| <code>function FileSetDate(Handle:Integer; Age:Integer):Integer; virtual;</code>
+
| <code>function FileSetDate(Handle:THandle; Age:Integer):Integer; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 1,039: Line 1,051:
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
−
| <code>function SetFileShortNameEx(Handle:Integer; const ShortName:String):Boolean; virtual;</code>
+
| <code>function SetFileShortNameEx(Handle:THandle; const ShortName:String):Boolean; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 1,076: Line 1,088:
 
|colspan="2"|&nbsp;
 
|colspan="2"|&nbsp;
 
|-
 
|-
−
| <code>function FileGetAttrEx(Handle:Integer):Integer; virtual;</code>
+
| <code>function FileGetAttrEx(Handle:THandle):Integer; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
 
|colspan="2"|&nbsp;
 
|colspan="2"|&nbsp;
 
|-
 
|-
−
| <code>function FileGetDateEx(Handle:Integer):TFileTime; virtual;</code>
+
| <code>function FileGetDateEx(Handle:THandle):TFileTime; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
−
| <code>function FileSetDateEx(Handle:Integer; Age:TFileTime):Integer; virtual;</code>
+
| <code>function FileSetDateEx(Handle:THandle; Age:TFileTime):Integer; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
−
| <code>function GetFileTime(Handle:Integer; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean; virtual;</code>
+
| <code>function GetFileTime(Handle:THandle; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
−
| <code>function SetFileTime(Handle:Integer; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean; virtual;</code>
+
| <code>function SetFileTime(Handle:THandle; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean; virtual;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 1,481: Line 1,493:
 
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.LoadSymbolicLinkTag:LongWord;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.LoadSymbolicLinkTag:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 +
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.LoadMinFileTime:TFileTime;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Load the Minimum File Time value (WriteTime/CreateTime/AccessTime)</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
Line 2,232: Line 2,256:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.GetEntryEx(AParent:TDiskEntry; const AName:String; AAttributes:LongWord; AAdd,ARemove,AWrite:Boolean):TDiskEntry; </pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.GetEntryEx(AParent:TDiskEntry; const AName:String; AAttributes:LongWord; AAdd,ARemove,AWrite:Boolean):TDiskEntry;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 2,477: Line 2,501:
 
</div></div>
 
</div></div>
 
<br />
 
<br />
−
{Also provides Wildcard matching based on File System rules}
 
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.CompareName(const AName,AMatch:String; AWildcard:Boolean):Boolean;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.CompareName(const AName,AMatch:String; AWildcard:Boolean):Boolean;</pre>
Line 2,485: Line 2,508:
 
|-
 
|-
 
! Note
 
! Note
−
| None documented
+
| Also provides Wildcard matching based on File System rules
 
|-
 
|-
 
|}
 
|}
Line 2,875: Line 2,898:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">procedure TFileSystem.FileClose(Handle:Integer);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure TFileSystem.FileClose(Handle:THandle);</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Close open handle</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Close open handle</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 2,923: Line 2,946:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileFlush(Handle:Integer):Boolean;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileFlush(Handle:THandle):Boolean;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Flush an open handle from Cache</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Flush an open handle from Cache</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 2,935: Line 2,958:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileTruncate(Handle:Integer):Boolean;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileTruncate(Handle:THandle):Boolean;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Truncate an open file at the current position</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Truncate an open file at the current position</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 2,983: Line 3,006:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileGetDate(Handle:Integer):Integer;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileGetDate(Handle:THandle):Integer;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the date/time of an existing entry with an open Handle</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the date/time of an existing entry with an open Handle</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 3,031: Line 3,054:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileSetDate(Handle:Integer; Age:Integer):Integer;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileSetDate(Handle:THandle; Age:Integer):Integer;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the date/time of an existing entry with an open Handle</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the date/time of an existing entry with an open Handle</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 3,405: Line 3,428:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.SetFileShortNameEx(Handle:Integer; const ShortName:String):Boolean;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.SetFileShortNameEx(Handle:THandle; const ShortName:String):Boolean;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 3,514: Line 3,537:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileGetAttrEx(Handle:Integer):Integer;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileGetAttrEx(Handle:THandle):Integer;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Attributes of an existing entry with an open Handle</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Attributes of an existing entry with an open Handle</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 3,526: Line 3,549:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileGetDateEx(Handle:Integer):TFileTime;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileGetDateEx(Handle:THandle):TFileTime;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Date/Time of an existing entry with an open Handle</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Date/Time of an existing entry with an open Handle</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 3,538: Line 3,561:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileSetDateEx(Handle:Integer; Age:TFileTime):Integer;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.FileSetDateEx(Handle:THandle; Age:TFileTime):Integer;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the Date/Time of an existing entry with an open Handle</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the Date/Time of an existing entry with an open Handle</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 3,550: Line 3,573:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.GetFileTime(Handle:Integer; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.GetFileTime(Handle:THandle; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Dates and Times of an existing entry with an open Handle</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the Dates and Times of an existing entry with an open Handle</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
Line 3,562: Line 3,585:
 
<br />
 
<br />
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
−
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.SetFileTime(Handle:Integer; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function TFileSystem.SetFileTime(Handle:THandle; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the Dates and Times of an existing entry with an open Handle</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the Dates and Times of an existing entry with an open Handle</div>
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">

Latest revision as of 04:49, 29 January 2025

Return to Unit Filesystem


Description

To be documented

Class definitions


[Expand]

TFileSystem = class(TListObject)


Function declarations


[Expand] 
constructor TFileSystem.Create(ADriver:TFileSysDriver; AVolume:TDiskVolume; ADrive:TDiskDrive);
Description: To be documented


[Expand] 
destructor TFileSystem.Destroy;
Description: To be documented


[Expand] 
function TFileSystem.AcquireLock:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.ReleaseLock:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SectorLock:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SectorUnlock:Boolean;
Description: To be documented


[Expand] 
procedure TFileSystem.SetDrive(ADrive:TDiskDrive);
Description: To be documented


[Expand] 
procedure TFileSystem.SetVolume(AVolume:TDiskVolume);
Description: To be documented


[Expand] 
function TFileSystem.GetPathChar:String;
Description: To be documented


[Expand] 
function TFileSystem.GetNameChar:String;
Description: To be documented


[Expand] 
function TFileSystem.GetFileChar:String;
Description: To be documented


[Expand] 
function TFileSystem.GetRootChar:String;
Description: To be documented


[Expand] 
function TFileSystem.GetRootName:String;
Description: To be documented


[Expand] 
function TFileSystem.GetRootPath:String;
Description: To be documented


[Expand] 
function TFileSystem.GetSystemName:String;
Description: To be documented


[Expand] 
function TFileSystem.GetVolumeName:String;
Description: To be documented


[Expand] 
function TFileSystem.GetVolumeGUID:String;
Description: To be documented


[Expand] 
function TFileSystem.LoadPathChar:String;
Description: Load the Path separator character


[Expand] 
function TFileSystem.LoadNameChar:String;
Description: Load the Name separator character


[Expand] 
function TFileSystem.LoadFileChar:String;
Description: Load the File separator character


[Expand] 
function TFileSystem.LoadRootChar:String;
Description: Load the Root specifier character (eg C:)


[Expand] 
function TFileSystem.LoadRootName:String;
Description: Load Root Name from Drive or Volume (eg C:\ or \\?\Volume1)


[Expand] 
function TFileSystem.LoadRootPath:String;
Description: Load Root Path from Volume or Drive (eg \\.\Harddisk0\Partition1 or C:\)


[Expand] 
function TFileSystem.LoadMaxFile:Integer;
Description: Load the maximum File name length


[Expand] 
function TFileSystem.LoadMaxPath:Integer;
Description: Load the maximum Path name length


[Expand] 
function TFileSystem.LoadMaxAltFile:Integer;
Description: Load the maximum Alt File name length


[Expand] 
function TFileSystem.LoadMaxAltPath:Integer;
Description: Load the maximum Alt Path name length


[Expand] 
function TFileSystem.LoadAttributes:LongWord;
Description: Load the File System (Volume) Attributes


[Expand] 
function TFileSystem.LoadMaxAttributes:LongWord;
Description: Load the Maximum File Attributes (FileSetAttr)


[Expand] 
function TFileSystem.LoadMaskAttributes:LongWord;
Description: Load the File Attributes Mask (FileGetAttr/FindFirstEx/FindNextEx)


[Expand] 
function TFileSystem.LoadMountPointTag:LongWord;
Description: To be documented


[Expand] 
function TFileSystem.LoadSymbolicLinkTag:LongWord;
Description: To be documented


[Expand] 
function TFileSystem.LoadMinFileTime:TFileTime;
Description: Load the Minimum File Time value (WriteTime/CreateTime/AccessTime)


[Expand] 
function TFileSystem.LoadSystemName:String;
Description: To be documented


[Expand] 
function TFileSystem.LoadVolumeName:String;
Description: To be documented


[Expand] 
function TFileSystem.LoadVolumeGUID:String;
Description: To be documented


[Expand] 
function TFileSystem.LoadVolumeSerial:LongWord;
Description: To be documented


[Expand] 
function TFileSystem.LoadFileSysType:TFileSysType;
Description: To be documented


[Expand] 
function TFileSystem.LoadSectorSize:Word;
Description: Load Sector Size from Volume


[Expand] 
function TFileSystem.LoadStartSector:Int64;
Description: Load Start Sector from Volume


[Expand] 
function TFileSystem.LoadSectorCount:LongWord;
Description: Load Sector Count from Volume


[Expand] 
function TFileSystem.GetCurrent:TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.SetCurrent(ACurrent:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.FillSectors(ASector,ACount:LongWord; AValue:Byte):Boolean;
Description: Fill specified number of sectors with the supplied value


[Expand] 
function TFileSystem.ReadSectors(ASector,ACount:LongWord; var ABuffer):Boolean;
Description: Read Sectors from the Volume using Cache


[Expand] 
function TFileSystem.WriteSectors(ASector,ACount:LongWord; const ABuffer):Boolean;
Description: Write Sectors to the Volume using Cache


[Expand] 
function TFileSystem.ReadEntry(AParent,AEntry:TDiskEntry; var ABuffer; const AStart:Int64; ACount:LongWord; var AOffset,AValue:LongWord):Integer;
Description: To be documented


[Expand] 
function TFileSystem.WriteEntry(AParent,AEntry:TDiskEntry; const ABuffer; const AStart:Int64; ACount:LongWord; var AOffset,AValue:LongWord):Integer;
Description: To be documented


[Expand] 
function TFileSystem.LoadTables:Boolean;
Description: Load all Disk Tables


[Expand] 
function TFileSystem.LoadBlocks:Boolean;
Description: Load all Disk Blocks


[Expand] 
function TFileSystem.LoadEntries(AParent:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.LoadCatalogs:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.LoadTable(ATableNo:LongWord):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.LoadBlock(ABlockNo:LongWord):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.UnloadEntries(AParent:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.AddEntry(AParent:TDiskEntry; const AName:String; AAttributes:LongWord; AReference:Boolean):TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.AddEntryEx(AParent:TDiskEntry; const AName,AAltName:String; AAttributes:LongWord; AReference:Boolean):TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.RemoveEntry(AParent,AEntry:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.RenameEntry(AParent,AEntry:TDiskEntry; const AName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.RenameEntryEx(AParent,AEntry:TDiskEntry; const AAltName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.MoveEntry(ASource,ADest,AEntry:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.AddCatalog(AEntry:TDiskEntry; AMediaType:TMediaType; AFloppyType:TFloppyType; AAttributes:LongWord; ASectorSize:Word; const ASectorCount:Int64):TDiskCatalog;
Description: To be documented


[Expand] 
function TFileSystem.RemoveCatalog(ACatalog:TDiskCatalog):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.CheckCatalog(ACatalog:TDiskCatalog; ALock:Boolean; AState:LongWord):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.GetCatalogByNo(ACatalogNo:LongWord; ALock:Boolean; AState:LongWord):TDiskCatalog;
Description: To be documented


[Expand] 
function TFileSystem.GetCatalogByName(const AName:String; ALock:Boolean; AState:LongWord):TDiskCatalog;
Description: To be documented


[Expand] 
function TFileSystem.GetCatalogByNext(APrevious:TDiskCatalog; ALock,AUnlock:Boolean; AState:LongWord):TDiskCatalog;
Description: To be documented


[Expand] 
function TFileSystem.GetNextCatalogNo:LongWord;
Description: To be documented


[Expand] 
function TFileSystem.GetMaxCatalogNo:LongWord;
Description: To be documented


[Expand] 
function TFileSystem.AddHardlink(AEntry,AParent:TDiskEntry; const AName:String; AReference:Boolean):TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.RemoveHardlink(AParent,AEntry:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.AddMountPoint(AEntry:TDiskEntry; const ATarget:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.RemoveMountPoint(AEntry:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.AddJunctionPoint(AEntry:TDiskEntry; const ATarget:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.RemoveJunctionPoint(AEntry:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.AddSymbolicLink(AParent:TDiskEntry; const AName,ATarget:String; AFolder,AReference:Boolean):TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.AddSymbolicLinkEx(AParent:TDiskEntry; const AName,AAltName,ATarget:String; AFolder,AReference:Boolean):TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.RemoveSymbolicLink(AParent,AEntry:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SetTable(ATable:TDiskTable):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SetBlock(ABlock:TDiskBlock):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SetEntry(AParent,AEntry:TDiskEntry):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SetCatalog(ACatalog:TDiskCatalog):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SetReparse(AParent,AEntry:TDiskEntry; AReparse:TDiskReparse):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SetSecurity(AParent,AEntry:TDiskEntry; ASecurity:TDiskSecurity):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SizeEntry(AParent,AEntry:TDiskEntry; const ASize:Int64):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.GetTable(ATableNo:LongWord):TDiskTable;
Description: To be documented


[Expand] 
function TFileSystem.GetTableEx(ATableNo:LongWord; AWrite:Boolean):TDiskTable;
Description: To be documented


[Expand] 
function TFileSystem.GetBlock(ABlockNo:LongWord):TDiskBlock;
Description: To be documented


[Expand] 
function TFileSystem.GetBlockEx(ABlockNo:LongWord; AWrite:Boolean):TDiskBlock;
Description: To be documented


[Expand] 
function TFileSystem.GetEntry(AParent:TDiskEntry; const AName:String; AAttributes:LongWord):TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.GetEntryEx(AParent:TDiskEntry; const AName:String; AAttributes:LongWord; AAdd,ARemove,AWrite:Boolean):TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.GetCatalog(ACatalogNo:LongWord):TDiskCatalog;
Description: To be documented


[Expand] 
function TFileSystem.GetCatalogEx(ACatalogNo:LongWord; AWrite:Boolean):TDiskCatalog;
Description: To be documented


[Expand] 
function TFileSystem.GetReparse(AEntry:TDiskEntry):TDiskReparse;
Description: To be documented


[Expand] 
function TFileSystem.GetSecurity(AEntry:TDiskEntry):TDiskSecurity;
Description: To be documented


[Expand] 
function TFileSystem.MatchEntry(AParent,APrevious:TDiskEntry; const AName:String; AAttributes:LongWord; AAny:Boolean):TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.MatchEntryEx(AParent,APrevious:TDiskEntry; const AName:String; AAttributes:LongWord; AAny,AAdd,ARemove,AWrite:Boolean):TDiskEntry;
Description: To be documented


[Expand] 
function TFileSystem.GetEntryPath(AEntry:TDiskEntry; AAltName:Boolean):String;
Description: Get the Full Path of an Entry (Not including Entry itself)


[Expand] 
function TFileSystem.GetEntryName(AEntry:TDiskEntry; AAltName:Boolean):String;
Description: Get the Full Name of an Entry (Including Entry itself)


[Expand] 
function TFileSystem.SplitPath(const APath:String; var ARelative:Boolean; AFolders:TStrings; var AName:String):Boolean;
Description: Split a Path into the component parts


[Expand] 
function TFileSystem.SplitName(const AName:String; var AFile,AStream:String):Boolean;
Description: Split a Name into the component parts (File and Stream)


[Expand] 
function TFileSystem.SplitFile(const AFile:String; var AName,AExt:String):Boolean;
Description: Split a File into the component parts (Name and Ext)


[Expand] 
function TFileSystem.SplitStream(const AStream:String; var AName,AType:String):Boolean;
Description: Split a Stream into the component parts (Name and Type)


[Expand] 
function TFileSystem.BuildPath(ARelative:Boolean; AFolders:TLinkedStringList; const AName:String):String;
Description: Build Path from the component parts


[Expand] 
function TFileSystem.BuildName(const AFile,AStream:String):String;
Description: Build a Name from the component parts (File and Stream)


[Expand] 
function TFileSystem.BuildFile(const AName,AExt:String):String;
Description: Build a File from the component parts (Name and Ext)


[Expand] 
function TFileSystem.BuildStream(const AName,AType:String):String;
Description: Build a Stream from the component parts (Name and Type)


[Expand] 
function TFileSystem.CheckName(const AName:String):Boolean;
Description: Performs Name validation based on File System rules


[Expand] 
function TFileSystem.CompareName(const AName,AMatch:String; AWildcard:Boolean):Boolean;
Description: Perform Name matching based on File System rules for Case-sensitivity etc


[Expand] 
function TFileSystem.CheckAltName(const AAltName:String):Boolean;
Description: Performs Name validation based on File System rules


[Expand] 
function TFileSystem.CompareAltName(const AAltName,AMatch:String; AWildcard:Boolean):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.CheckLinkName(const AName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.GetSecurityFromDescriptor(ADescriptor:Pointer):TDiskSecurity;
Description: To be documented


[Expand] 
function TFileSystem.GetDescriptorFromSecurity(ASecurity:TDiskSecurity; ADescriptor:Pointer; var ASize:LongWord):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.ReaderLock:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.ReaderUnlock:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.ReaderConvert:Boolean;
Description: Convert a Reader lock to a Writer lock


[Expand] 
function TFileSystem.WriterLock:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.WriterUnlock:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.WriterConvert:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.FileSystemInit:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.MountFileSystem:Boolean;
Description: To be documented

[Expand] 
function TFileSystem.DismountFileSystem:Boolean;
Description: To be documented


[Expand] 
function TFileSystem.InitializeFileSystem(ASectorsPerCluster:LongWord; AFileSysType:TFileSysType):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.CreateCatalog(const AName:String; AMediaType:TMediaType; AFloppyType:TFloppyType; AAttributes:LongWord; ASectorSize:Word; const ASectorCount:Int64):LongWord;
Description: To be documented


[Expand] 
function TFileSystem.DeleteCatalog(ACatalogNo:LongWord):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.FindFirstCatalog(var ASearchRec:TCatalogSearchRec):Integer;
Description: To be documented


[Expand] 
function TFileSystem.FindNextCatalog(var ASearchRec:TCatalogSearchRec):Integer;
Description: To be documented


[Expand] 
procedure TFileSystem.FindCatalogClose(var ASearchRec:TCatalogSearchRec);
Description: Close an open find Handle


[Expand] 
function TFileSystem.GetDriveLabel:String;
Description: To be documented


[Expand] 
function TFileSystem.SetDriveLabel(const ALabel:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.GetDriveSerial:LongWord;
Description: To be documented


[Expand] 
function TFileSystem.SetDriveSerial(ASerial:LongWord):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.GetDriveFreeSpace:LongWord;
Description: Return the Free space on Drive up to 2GB


[Expand] 
function TFileSystem.GetDriveFreeSpaceEx:Int64;
Description: To be documented


[Expand] 
function TFileSystem.GetDriveTotalSpace:LongWord;
Description: Return the Total space on Drive up to 2GB


[Expand] 
function TFileSystem.GetDriveTotalSpaceEx:Int64;
Description: Return the Total space on Drive up to 4TB


[Expand] 
function TFileSystem.GetDriveInformation(var AClusterSize:LongWord; var ATotalClusterCount,AFreeClusterCount:Int64):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.FileOpen(const FileName:String; Mode:Integer):THandle;
Description: Open existing entry and return Handle


[Expand] 
function TFileSystem.FileCreate(const FileName:String; Mode:Integer = fmOpenReadWrite or fmShareExclusive):THandle;
Description: Create new entry or truncate existing entry and return Handle


[Expand] 
function TFileSystem.DeleteFile(const FileName:String):Boolean;
Description: Delete existing entry


[Expand] 
procedure TFileSystem.FileClose(Handle:THandle);
Description: Close open handle


[Expand] 
function TFileSystem.RenameFile(const OldName,NewName:String):Boolean;
Description: Rename existing entry


[Expand] 
function TFileSystem.FileSeek(Handle:THandle; Offset,Origin:LongInt):LongInt;
Description: Move the position of an open handle


[Expand] 
function TFileSystem.FileSeekEx(Handle:THandle; const Offset:Int64; Origin:LongInt):Int64;
Description: Move the position of an open handle


[Expand] 
function TFileSystem.FileFlush(Handle:THandle):Boolean;
Description: Flush an open handle from Cache


[Expand] 
function TFileSystem.FileTruncate(Handle:THandle):Boolean;
Description: Truncate an open file at the current position


[Expand] 
function TFileSystem.FilePos(Handle:THandle):LongInt;
Description: Return the position of an open Handle


[Expand] 
function TFileSystem.FilePosEx(Handle:THandle):Int64;
Description: Return the position of an open Handle


[Expand] 
function TFileSystem.FileGetAttr(const FileName:String):Integer;
Description: Get the attributes of an existing entry


[Expand] 
function TFileSystem.FileGetDate(Handle:THandle):Integer;
Description: Get the date/time of an existing entry with an open Handle


[Expand] 
function TFileSystem.FileGetSize(Handle:THandle):LongInt;
Description: Get the size of an existing entry with an open Handle


[Expand] 
function TFileSystem.FileGetSizeEx(Handle:THandle):Int64;
Description: Get the size of an existing entry with an open Handle


[Expand] 
function TFileSystem.FileSetAttr(const FileName:String; Attr:Integer):Integer;
Description: Set the attributes of an existing entry


[Expand] 
function TFileSystem.FileSetDate(Handle:THandle; Age:Integer):Integer;
Description: Set the date/time of an existing entry with an open Handle


[Expand] 
function TFileSystem.FileSetSize(Handle:THandle; Size:LongInt):LongInt;
Description: Set the size of an existing entry with an open Handle


[Expand] 
function TFileSystem.FileSetSizeEx(Handle:THandle; const Size:Int64):LongInt;
Description: Set the size of an existing entry with Open handle


[Expand] 
function TFileSystem.FileRead(Handle:THandle; var Buffer;Count:LongInt):LongInt;
Description: Read data from an existing entry with an open Handle


[Expand] 
function TFileSystem.FileWrite(Handle:THandle; const Buffer; Count:LongInt):LongInt;
Description: Write data to an existing entry with an open Handle


[Expand] 
function TFileSystem.CreateDir(const DirName:String):Boolean;
Description: Create a new entry


[Expand] 
function TFileSystem.RemoveDir(const DirName:String):Boolean;
Description: Delete an existing entry


[Expand] 
function TFileSystem.GetCurrentDir:String;
Description: Return the current directory


[Expand] 
function TFileSystem.SetCurrentDir(const DirName:String):Boolean;
Description: Set the current directory to an existing entry}{No File or Stream support


[Expand] 
function TFileSystem.FindFirstEx(const Path:String; var SearchRec:TFileSearchRec):Integer;
Description: Find existing entries matching the specifications


[Expand] 
function TFileSystem.FindNextEx(var SearchRec:TFileSearchRec):Integer;
Description: Continue Finding existing entries matching the specifications


[Expand] 
procedure TFileSystem.FindCloseEx(var SearchRec:TFileSearchRec);
Description: Close an open find Handle


[Expand] 
function TFileSystem.FindFirstStream(const FileName:String; var SearchRec:TStreamSearchRec):Integer;
Description: Find existing streams matching the specifications


[Expand] 
function TFileSystem.FindNextStream(var SearchRec:TStreamSearchRec):Integer;
Description: Continue finding existing streams matching the specifications


[Expand] 
procedure TFileSystem.FindStreamClose(var SearchRec:TStreamSearchRec);
Description: Close an open find Handle


[Expand] 
function TFileSystem.FindFirstFileName(const FileName:String; var SearchRec:TLinkSearchRec):Integer;
Description: Find existing file names matching the specifications


[Expand] 
function TFileSystem.FindNextFileName(var SearchRec:TLinkSearchRec):Integer;
Description: Continue finding existing file names matching the specifications


[Expand] 
procedure TFileSystem.FindFileNameClose(var SearchRec:TLinkSearchRec);
Description: Close an open find Handle


[Expand] 
function TFileSystem.CreateHardLink(const LinkName,FileName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.DeleteHardLink(const LinkName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.CreateMountPoint(const PathName,VolumeName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.DeleteMountPoint(const PathName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.CreateJunctionPoint(const PathName,FolderName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.DeleteJunctionPoint(const PathName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.CreateSymbolicLink(const LinkName,TargetName:String; Directory:Boolean):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.CreateSymbolicLinkEx(const LinkName,ShortName,TargetName:String; Directory:Boolean):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.DeleteSymbolicLink(const LinkName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.GetMountPointTarget(const PathName:String):String;
Description: To be documented


[Expand] 
function TFileSystem.GetJunctionPointTarget(const PathName:String):String;
Description: To be documented


[Expand] 
function TFileSystem.GetSymbolicLinkTarget(const LinkName:String):String;
Description: To be documented


[Expand] 
function TFileSystem.SetFileShortName(const FileName,ShortName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SetFileShortNameEx(Handle:THandle; const ShortName:String):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.GetFileSecurity(const FileName:String; Descriptor:Pointer; var Size:LongWord):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.SetFileSecurity(const FileName:String; Descriptor:Pointer):Boolean;
Description: To be documented


[Expand] 
function TFileSystem.GetPathName(const FileName:String):String;
Description: Get the path from the supplied name (Does not include trailing slash)


[Expand] 
function TFileSystem.GetShortName(const FileName:String):String;
Description: Convert the supplied name to its Short name form


[Expand] 
function TFileSystem.GetLongName(const FileName:String):String;
Description: Convert the supplied name to its Long name form


[Expand] 
function TFileSystem.GetTrueName(const FileName:String):String;
Description: Convert the supplied name to its True name form


[Expand] 
function TFileSystem.FileCreateEx(const FileName,ShortName:String; Mode:Integer = fmOpenReadWrite or fmShareExclusive):THandle;
Description: Create new entry or truncate existing entry and return Handle


[Expand] 
function TFileSystem.CreateDirEx(const DirName,ShortName:String):Boolean;
Description: Create a new entry}{No File or Stream support


[Expand] 
function TFileSystem.FileGetAttrEx(Handle:THandle):Integer;
Description: Get the Attributes of an existing entry with an open Handle


[Expand] 
function TFileSystem.FileGetDateEx(Handle:THandle):TFileTime;
Description: Get the Date/Time of an existing entry with an open Handle


[Expand] 
function TFileSystem.FileSetDateEx(Handle:THandle; Age:TFileTime):Integer;
Description: Set the Date/Time of an existing entry with an open Handle


[Expand] 
function TFileSystem.GetFileTime(Handle:THandle; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean;
Description: Get the Dates and Times of an existing entry with an open Handle


[Expand] 
function TFileSystem.SetFileTime(Handle:THandle; CreateTime,AccessTime,ModifyTime:PFileTime):Boolean;
Description: Set the Dates and Times of an existing entry with an open Handle


[Expand] 
function TFileSystem.CloseFile(Handle:THandle):Boolean;
Description: Close open handle


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=TFileSystem&oldid=5935"