TRecognizer - Revision history

Ultibo: Created page with "Return to Unit Filesystem TOC === Description === ---- ''To be documented'' === Class definitions === ----

2018-05-17T03:57:01Z

Created page with "Return to Unit Filesystem TOC === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible..."

New page
Return to [[Unit_Filesystem|Unit Filesystem]]

TOC

=== Description ===
----

''To be documented''

=== Class definitions ===
----

<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">

<code>TRecognizer = class(TListObject)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
| <code>constructor Create(ADriver:TFileSysDriver);</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FLock:TSynchronizerHandle;</code>
|  
|-
| <code>FLocalLock:TMutexHandle;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
|-
| <code>FDriver:TFileSysDriver;</code>
|  
|-
|colspan="2"| 
|-
| <code>FAllowDrive:Boolean;</code>
| Enable mounting with an attached Drive
|-
| <code>FAllowDefault:Boolean;</code>
| Enable mounting of unrecognized media (Unpartitioned Media Only)
|-
|colspan="2"| 
|-
| <code>FDirtyCheck:Boolean;</code>
| Enable checking Volume when dirty flag set on mount
|-
| <code>FQuickCheck:Boolean;</code>
| Enable quick check only when checking dirty Volume
|-
|colspan="2"| 
|-
| <code>FPartitioner:TDiskPartitioner;</code>
|  
|-
| <code>FFormatter:TDiskFormatter;</code>
|  
|-
| <code>FDefragger:TDiskDefragger;</code>
|  
|-
| <code>FConverter:TDiskConverter;</code>
|  
|-
| <code>FRepairer:TDiskRepairer;</code>
|  
|-
| <code>FResizer:TDiskResizer;</code>
|  
|-
| <code>FCopier:TDiskCopier;</code>
|  
|-
| <code>FImager:TDiskImager;</code>
|  
|-
|colspan="2"| 
|-
| <code>function AcquireLock:Boolean;</code>
|  
|-
| <code>function ReleaseLock:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function GetName:String; virtual;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property Name:String read GetName;</code>
|  
|-
|colspan="2"| 
|-
| <code>property AllowDrive:Boolean read FAllowDrive write FAllowDrive;</code>
|  
|-
| <code>property AllowDefault:Boolean read FAllowDefault write FAllowDefault;</code>
|  
|-
|colspan="2"| 
|-
| <code>property DirtyCheck:Boolean read FDirtyCheck write FDirtyCheck;</code>
|  
|-
| <code>property QuickCheck:Boolean read FQuickCheck write FQuickCheck;</code>
|  
|-
|colspan="2"| 
|-
| <code>property Partitioner:TDiskPartitioner read FPartitioner write FPartitioner;</code>
|  
|-
| <code>property Formatter:TDiskFormatter read FFormatter write FFormatter;</code>
|  
|-
| <code>property Defragger:TDiskDefragger read FDefragger write FDefragger;</code>
|  
|-
| <code>property Converter:TDiskConverter read FConverter write FConverter;</code>
|  
|-
| <code>property Repairer:TDiskRepairer read FRepairer write FRepairer;</code>
|  
|-
| <code>property Resizer:TDiskResizer read FResizer write FResizer;</code>
|  
|-
| <code>property Copier:TDiskCopier read FCopier write FCopier;</code>
|  
|-
| <code>property Imager:TDiskImager read FImager write FImager;</code>
|  
|-
|colspan="2"| 
|-
| <code>function ReaderLock:Boolean;</code>
|  
|-
| <code>function ReaderUnlock:Boolean;</code>
|  
|-
| <code>function ReaderConvert:Boolean;</code>
|  
|-
| <code>function WriterLock:Boolean;</code>
|  
|-
| <code>function WriterUnlock:Boolean;</code>
|  
|-
| <code>function WriterConvert:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function RecognizePartitionId(APartitionId:Byte):Boolean; virtual;</code>
|  
|-
| <code>function RecognizeBootSector(ABootSector:PBootSector; const AStartSector,ASectorCount:Int64):Boolean; virtual;</code>
|  
|-
|colspan="2"| 
|-
| <code>function RecognizePartition(APartition:TDiskPartition):Boolean; virtual;</code>
|  
|-
| <code>function RecognizeVolume(AVolume:TDiskVolume):Boolean; virtual;</code>
|  
|-
| <code>function MountVolume(AVolume:TDiskVolume; ADrive:TDiskDrive):Boolean; virtual;</code>
|  
|-
| <code>function DismountVolume(AVolume:TDiskVolume):Boolean; virtual;</code>
|  
|-
|colspan="2"| 
|-
| <code>function RecognizeImage(AImage:TDiskImage):Boolean; virtual;</code>
|  
|-
| <code>function MountImage(AImage:TDiskImage):Boolean; virtual;</code>
|  
|-
| <code>function DismountImage(AImage:TDiskImage):Boolean; virtual;</code>
|  
|-
| <code>function InsertImage(AImage:TDiskImage):Boolean; virtual;</code>
|  
|-
| <code>function EjectImage(AImage:TDiskImage):Boolean; virtual;</code>
|  
|-
|}
</div></div>
<br />

=== Function declarations ===
----

<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;">constructor TRecognizer.Create(ADriver:TFileSysDriver);</pre>
<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;">destructor TRecognizer.Destroy;</pre>
<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 TRecognizer.AcquireLock:Boolean;</pre>
<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 TRecognizer.ReleaseLock:Boolean;</pre>
<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 TRecognizer.GetName:String;</pre>
<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 TRecognizer.ReaderLock:Boolean;</pre>
<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 TRecognizer.ReaderUnlock:Boolean;</pre>
<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 TRecognizer.ReaderConvert:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a Reader lock to a Writer lock</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 TRecognizer.WriterLock:Boolean;</pre>
<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 TRecognizer.WriterUnlock:Boolean;</pre>
<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 TRecognizer.WriterConvert:Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a Writer lock to a Reader lock</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 TRecognizer.RecognizePartitionId(APartitionId:Byte):Boolean;</pre>
<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 TRecognizer.RecognizeBootSector(ABootSector:PBootSector; const AStartSector,ASectorCount:Int64):Boolean;</pre>
<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 TRecognizer.RecognizePartition(APartition:TDiskPartition):Boolean;</pre>
<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
| Caller must hold the partition lock
|-
|}
</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 TRecognizer.RecognizeVolume(AVolume:TDiskVolume):Boolean;</pre>
<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
| Caller must hold the volume lock
|-
|}
</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 TRecognizer.MountVolume(AVolume:TDiskVolume; ADrive:TDiskDrive):Boolean;</pre>
<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
| Caller must hold the volume and drive locks
|-
|}
</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 TRecognizer.DismountVolume(AVolume:TDiskVolume):Boolean;</pre>
<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
| Dismount does not free the Volume only the FileSystem and Drive(s)
Caller must hold the volume writer lock
|-
|}
</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 TRecognizer.RecognizeImage(AImage:TDiskImage):Boolean;</pre>
<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
| Caller must hold the image lock
|-
|}
</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 TRecognizer.MountImage(AImage:TDiskImage):Boolean;</pre>
<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
| Caller must hold the image lock
|-
|}
</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 TRecognizer.DismountImage(AImage:TDiskImage):Boolean;</pre>
<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
| Dismount closes the Image and frees Device, Partitions, Volumes, Drives.
Caller must hold the image lock
|-
|}
</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 TRecognizer.InsertImage(AImage:TDiskImage):Boolean;</pre>
<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
| Caller must hold the image lock
|-
|}
</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 TRecognizer.EjectImage(AImage:TDiskImage):Boolean;</pre>
<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
| Eject closes the Image but does not free Device, Partitions, Volumes, Drives.
Caller must hold the image writer lock
|-
|}
</div></div>
<br />

Return to [[Unit_Reference|Unit Reference]]