TNTFSDiskItem - Revision history

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

2018-05-24T06:00:55Z

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

New page
Return to [[Unit_NTFSClass|Unit NTFSClass]]

TOC

=== Description ===
----

''To be documented''

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

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

<code>TNTFSDiskItem = class(TListObject)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: Data of attribute $ATTRIBUTE_LIST
|-
|colspan="2"| 
|-
| <code>constructor Create(ALocalLock:TMutexHandle; AParent:TNTFSDiskAttribute);</code>
| style="width: 50%;"| 
|-
| <code>destructor Destroy; override;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
|-
| <code>FLocalLock:TMutexHandle;</code>
|  
|-
|colspan="2"| 
|-
| <code>FStatus:LongWord;</code>
|  
|-
|colspan="2"| 
|-
| <code>FItemSize:Word;</code>
| Record length
|-
| <code>FStartVCN:Int64;</code>
| Starting VCN if non resident
|-
| <code>FFileReference:Int64;</code>
| File Reference of the attribute
|-
| <code>FAttributeType:LongWord;</code>
| Attribute Type
|-
| <code>FAttributeId:Word;</code>
| Attribute Id
|-
| <code>FAttributeName:String;</code>
| Name in Unicode (if NameLength > 0)
|-
|colspan="2"| 
|-
| <code>FParent:TNTFSDiskAttribute;</code>
| Attribute list owning this item
|-
| <code>FAttribute:TNTFSDiskAttribute;</code>
| Attribute pointed to by this item
|-
|colspan="2"| 
|-
| <code>FAttributeHash:LongWord;</code>
|  
|-
|colspan="2"| 
|-
| <code>function AcquireLock:Boolean;</code>
|  
|-
| <code>function ReleaseLock:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function GetInvalid:Boolean;</code>
|  
|-
| <code>procedure SetInvalid(AValue:Boolean);</code>
|  
|-
|colspan="2"| 
|-
| <code>function GetAttributeName:String;</code>
|  
|-
| <code>procedure SetAttributeName(const AAttributeName:String);</code>
|  
|-
| <code>procedure SetAttribute(AAttribute:TNTFSDiskAttribute);</code>
|  
|-
|colspan="2"| 
|-
| <code>function Compare(AItem:TNTFSDiskItem):Integer; virtual;</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property Invalid:Boolean read GetInvalid write SetInvalid;</code>
| Item points to invalid file record or attribute
|-
|colspan="2"| 
|-
| <code>property ItemSize:Word read FItemSize write FItemSize;</code>
|  
|-
| <code>property StartVCN:Int64 read FStartVCN write FStartVCN;</code>
|  
|-
| <code>property FileReference:Int64 read FFileReference write FFileReference;</code>
|  
|-
| <code>property AttributeType:LongWord read FAttributeType write FAttributeType;</code>
|  
|-
| <code>property AttributeId:Word read FAttributeId write FAttributeId;</code>
|  
|-
| <code>property AttributeName:String read GetAttributeName write SetAttributeName;</code>
|  
|-
|colspan="2"| 
|-
| <code>property Parent:TNTFSDiskAttribute read FParent;</code>
|  
|-
| <code>property Attribute:TNTFSDiskAttribute read FAttribute write SetAttribute;</code>
|  
|-
|colspan="2"| 
|-
| <code>property AttributeHash:LongWord read FAttributeHash;</code>
|  
|-
|colspan="2"| 
|-
| <code>function RecordNumber:Int64;</code>
|  
|-
|colspan="2"| 
|-
| <code>function AttributeNameSize:Word;</code>
|  
|-
| <code>function AttributeNameLength:Byte;</code>
| Name length
|-
| <code>function AttributeNameOffset:Byte;</code>
| Offset to Name
|-
|colspan="2"| 
|-
| <code>function UpdateItem:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function CalculatedSize(AVersion:Word):Word;</code>
|  
|-
|colspan="2"| 
|-
| <code>function ReadItem(ABuffer:Pointer; var AOffset,ASize:LongWord; AVersion:Word):Boolean;</code>
|  
|-
| <code>function WriteItem(ABuffer:Pointer; var AOffset,ASize:LongWord; AVersion:Word):Boolean;</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 TNTFSDiskItem.Create(ALocalLock:TMutexHandle; AParent:TNTFSDiskAttribute);</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 TNTFSDiskItem.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 TNTFSDiskItem.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 TNTFSDiskItem.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 TNTFSDiskItem.GetInvalid: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;">procedure TNTFSDiskItem.SetInvalid(AValue: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 TNTFSDiskItem.GetAttributeName: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;">procedure TNTFSDiskItem.SetAttributeName(const AAttributeName: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;">procedure TNTFSDiskItem.SetAttribute(AAttribute:TNTFSDiskAttribute);</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 TNTFSDiskItem.Compare(AItem:TNTFSDiskItem):Integer;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Compare item by type, name and vcn for sort order</div>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
! Note
| The passed item is the first value in a standard compare
Id is not used for sort order as it is unique per file record
<br />Name is compared using a case insensitive compare method
|-
|}
</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 TNTFSDiskItem.RecordNumber:Int64;</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 TNTFSDiskItem.AttributeNameSize:Word;</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 TNTFSDiskItem.AttributeNameLength:Byte;</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 TNTFSDiskItem.AttributeNameOffset:Byte;</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 TNTFSDiskItem.UpdateItem: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 TNTFSDiskItem.CalculatedSize(AVersion:Word):Word;</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
| Calculated Size includes any rounding required for alignment
|-
|}
</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 TNTFSDiskItem.ReadItem(ABuffer:Pointer; var AOffset,ASize:LongWord; AVersion:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read the item data from the supplied buffer at the supplied offset</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 TNTFSDiskItem.WriteItem(ABuffer:Pointer; var AOffset,ASize:LongWord; AVersion:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Write the item data to the supplied buffer at the supplied offset</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 />

Return to [[Unit_Reference|Unit Reference]]