TNTFSDiskKey - Revision history

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

2018-05-24T05:54:52Z

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>TNTFSDiskKey = class(TBtreeObject)</code>
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
{| class="wikitable" style="font-size: 14px; background: white;"
|-
|colspan="2"|Note: Represents an INDX record entry.
|-
|colspan="2"| 
|-
| <code>constructor Create(ALocalLock:TMutexHandle);</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>
|  
|-
| <code>FKey:Pointer;</code>
|  
|-
|colspan="2"| 
|-
| <code>FEntryFlags:Word;</code>
| Flags (See Consts)
|-
| <code>FEntrySize:Word;</code>
| Length of the index entry
|-
| <code>FKeySize:Word;</code>
| Length of the key entry
|-
| <code>FSubNodeNumber:Int64;</code>
| Number of the sub-node in the index allocation attribute
|-
|colspan="2"| 
|-
| <code>FNode:TNTFSDiskNode;</code>
| Index node of this key
|-
|colspan="2"| 
|-
| <code>function AcquireLock:Boolean;</code>
|  
|-
| <code>function ReleaseLock:Boolean;</code>
|  
|-
|colspan="2"| 
|-
| <code>function GetChanged:Boolean;</code>
|  
|-
| <code>procedure SetChanged(AValue:Boolean);</code>
|  
|-
|colspan="2"| 
|-
| <code>function GetHasSubNode:Boolean;</code>
|  
|-
| <code>procedure SetHasSubNode(AValue:Boolean);</code>
|  
|-
| <code>function GetIsLastNode:Boolean;</code>
|  
|-
| <code>procedure SetIsLastNode(AValue:Boolean);</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure SetKeySize(ASize:Word); virtual;</code>
|  
|-
| <code>procedure SetSubNodeNumber(const ANodeNumber:Int64);</code>
|  
|-
|colspan="2"| 
|-
| <code>procedure SetNode(ANode:TNTFSDiskNode);</code>
|  
|-
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
|-
| <code>property Changed:Boolean read GetChanged write SetChanged;</code>
| Index record to be updated
|-
|colspan="2"| 
|-
| <code>property HasSubNode:Boolean read GetHasSubNode write SetHasSubNode;</code>
|  
|-
| <code>property IsLastNode:Boolean read GetIsLastNode write SetIsLastNode;</code>
|  
|-
|colspan="2"| 
|-
| <code>property Key:Pointer read FKey;</code>
|  
|-
|colspan="2"| 
|-
| <code>property EntryFlags:Word read FEntryFlags write FEntryFlags;</code>
|  
|-
| <code>property EntrySize:Word read FEntrySize write FEntrySize;</code>
|  
|-
| <code>property KeySize:Word read FKeySize write SetKeySize;</code>
|  
|-
| <code>property SubNodeNumber:Int64 read FSubNodeNumber write SetSubNodeNumber;</code>
|  
|-
|colspan="2"| 
|-
| <code>property Node:TNTFSDiskNode read FNode write SetNode;</code>
|  
|-
|colspan="2"| 
|-
| <code>function CalculatedSize(AVersion:Word):Word; virtual;</code>
|  
|-
|colspan="2"| 
|-
| <code>function ReadKey(ABuffer:Pointer; var AOffset,ASize:LongWord; AVersion:Word):Boolean; virtual;</code>
|  
|-
| <code>function WriteKey(ABuffer:Pointer; var AOffset,ASize:LongWord; AVersion:Word):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 TNTFSDiskKey.Create(ALocalLock:TMutexHandle);</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 TNTFSDiskKey.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 TNTFSDiskKey.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 TNTFSDiskKey.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 TNTFSDiskKey.GetChanged: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 TNTFSDiskKey.SetChanged(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 TNTFSDiskKey.GetHasSubNode: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 TNTFSDiskKey.SetHasSubNode(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 TNTFSDiskKey.GetIsLastNode: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 TNTFSDiskKey.SetIsLastNode(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;">procedure TNTFSDiskKey.SetKeySize(ASize: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;">procedure TNTFSDiskKey.SetSubNodeNumber(const ANodeNumber: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;">procedure TNTFSDiskKey.SetNode(ANode:TNTFSDiskNode);</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 TNTFSDiskKey.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 TNTFSDiskKey.ReadKey(ABuffer:Pointer; var AOffset,ASize:LongWord; AVersion:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read the index entry 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 TNTFSDiskKey.WriteKey(ABuffer:Pointer; var AOffset,ASize:LongWord; AVersion:Word):Boolean;</pre>
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Write the index entry 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]]