Difference between revisions of "Unit UltiboUtils"

From Ultibo.org
Jump to: navigation, search
Line 792: Line 792:
 
! '''Note'''
 
! '''Note'''
 
| The returned string must be freed using LocalFree
 
| The returned string must be freed using LocalFree
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
 +
'''File functions'''
 +
 +
<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 IsRootDirectory(const Path:String):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'''
 +
| To be 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 IsEightDotThree(const FileName:String):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'''
 +
| To be 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 TruncateLongName(const FileName:String):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'''
 +
| To be 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 GenerateShortName(const FileName:String; AliasCount:Integer):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'''
 +
| If AliasCount is less than 0 then dont generate the numeric tail
 +
|-
 +
|}
 +
</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 GenerateShortNameEx(const FileName:String; AliasCount:Integer; Hash:Word; UseHash:Boolean):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'''
 +
| If AliasCount is less than 0 then dont generate the numeric tail
 +
|-
 +
|}
 +
</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 WildcardFileMatch(const FileName,Wildcard:String; CaseSensitive:Boolean):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'''
 +
| To be 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 GetFileInfo(const FileName:String; var FileTime,FileSize:Integer; var FileAttr:LongWord):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'''
 +
| To be 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 CompareFileInfo(const SourceFile,DestFile:String):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'''
 +
| To be documented
 
|-
 
|-
 
|}
 
|}

Revision as of 04:25, 9 September 2016

Return to Unit Reference


Description


To be documented

Constants


To be documented

Type definitions


To be documented

Public variables


To be documented

Function declarations



String functions

function GetFirstWord(var AValue:String; ADelimiter:String):String;
Description: To be documented
Note To be documented


function GetLastWord(var AValue:String; ADelimiter:String):String;
Description: To be documented
Note To be documented


function PadString(const AValue:String; AChar:Char;ALength:Integer):String;
Description: System StringOfChar may not handle Length < 0 correctly
Note To be documented


function StrOfChar(const AValue:String; ALength:Integer):String;
Description: Use System StringOfChar instead
Note To be documented


function StrToBool(const AValue:String):Boolean;
Description: To be documented
Note To be documented


function IntToStrLen(AValue:Integer; ADigits:Integer):String;
Description: To be documented
Note To be documented


function StrToLongWord(const AValue:String):LongWord;
Description: To be documented
Note To be documented


function BoolToStr(AValue:Boolean):String;
Description: To be documented
Note To be documented


function BoolToStrEx(AValue:Boolean; AType:Integer):String;
Description: To be documented
Note To be documented


function InFixStr(const Value:String):String;
Description: To be documented
Note To be documented


function InFixStrEx(const Value:String):String;
Description: To be documented
Note To be documented


function RemoveSpaces(const Text:String):String;
Description: To be documented
Note To be documented


function SpaceCount(const Text:String):Integer;
Description: To be documented
Note To be documented


function NormaliseSpaces(const Text:String):String;
Description: To be documented
Note To be documented


function NormaliseCase(const Text:String):String;
Description: To be documented
Note To be documented


function StringFill(const Text:String; Count:Integer):String;
Description: To be documented
Note To be documented


function RemoveQuotes(const AValue:String):String;
Description: To be documented
Note To be documented


function RemoveBraces(const AValue:String):String;
Description: To be documented
Note To be documented


function RemoveBrackets(const AValue:String):String;
Description: To be documented
Note To be documented


function RemoveSingleQuotes(const AValue:String):String;
Description: To be documented
Note To be documented


function RemoveCurlyBraces(const AValue:String):String;
Description: To be documented
Note To be documented


function IsAlpha(const AValue:String):Boolean;
Description: To be documented
Note To be documented


function IsNumeric(const AValue:String):Boolean;
Description: To be documented
Note To be documented


function RemoveNonAlpha(const Value:String):String;
Description: To be documented
Note To be documented


function AddQuotes(const AValue:String):String;
Description: To be documented
Note To be documented


function AddBraces(const AValue:String):String;
Description: To be documented
Note To be documented


function AddBrackets(const AValue:String):String;
Description: To be documented
Note To be documented


function AddSingleQuotes(const AValue:String):String;
Description: To be documented
Note To be documented


function AddCurlyBraces(const AValue:String):String;
Description: To be documented
Note To be documented


function NoOfChars(const AValue:String; AChar:Char):Integer;
Description: To be documented
Note To be documented


function ReplaceChar(const AValue:String; AChar,AReplace:Char):String;
Description: To be documented
Note To be documented


function EncodeString(const AValue,AKey:String):String;
Description: To be documented
Note To be documented


function DecodeString(const AValue,AKey:String):String;
Description: To be documented
Note To be documented


procedure DelimitStrings(AStrings:TStrings; var AString:String; const ADelimiter:String);
Description: To be documented
Note To be documented


procedure UndelimitString(AString:String; AStrings:TStrings; const ADelimiter:String);
Description: To be documented
Note To be documented


procedure UndelimitQuotedString(AString:String; AStrings:TStrings; const ADelimiter:String);
Description: To be documented
Note To be documented


function AddSlashes(const AFilePath:String):String;
Description: To be documented
Note To be documented


function AddTrailingSlash(const AFilePath:String):String;
Description: To be documented
Note To be documented


function AddLeadingSlash(const AFilePath:String):String;
Description: To be documented
Note To be documented


function StripSlashes(const AFilePath:String):String;
Description: To be documented
Note To be documented


function StripTrailingSlash(const AFilePath:String):String;
Description: To be documented
Note To be documented


function StripLeadingSlash(const AFilePath:String):String;
Description: To be documented
Note To be documented


function AddTrailingDot(const AValue:String):String;
Description: To be documented
Note To be documented


function AddLeadingDot(const AValue:String):String;
Description: To be documented
Note To be documented


function StripTrailingDot(const AValue:String):String;
Description: To be documented
Note To be documented


function StripLeadingDot(const AValue:String):String;
Description: To be documented
Note To be documented


function AddTrailingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
Note To be documented


function AddLeadingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
Note To be documented


function StripTrailingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
Note To be documented


function StripLeadingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
Note To be documented


function IsWildcard(const Value:String):Boolean;
Description: To be documented
Note To be documented


function UniqueName(const BaseName:String; CurrentNames:TStrings):String;
Description: To be documented
Note To be documented


function WildcardNameMatch(const Name,Wildcard:String; CaseSensitive:Boolean):Boolean;
Description: To be documented
Note To be documented


function AddQuotesIfSpaced(const AValue:String):String;
Description: To be documented
Note To be documented


function ExtractCommand(const ACommandLine:String):String;
Description: To be documented
Note To be documented


function ExtractParameters(const ACommandLine:String):String;
Description: To be documented
Note To be documented


function MultiStringToStrings(ABuffer:Pointer; ASize:Integer; AStrings:TStrings):Boolean;
Description: To be documented
Note To be documented


function StringsToMultiString(AStrings:TStrings; var ABuffer:Pointer; var ASize:Integer):Boolean;
Description: To be documented
Note The returned buffer must be freed using FreeMem


function MultiStringToDelimited(ABuffer:PChar; ADelimiter:String):String;
Description: To be documented
Note To be documented


function DelimitedToMultiString(const AString:String; ADelimiter:String):PChar;
Description: To be documented
Note The returned string must be freed using LocalFree


function DuplicateString(AString:PChar):PChar;
Description: To be documented
Note The returned string must be freed using LocalFree


function DuplicateWideString(AString:PWideChar):PWideChar;
Description: To be documented
Note The returned string must be freed using LocalFree


function DuplicateMultiString(AString:PChar):PChar;
Description: To be documented
Note The returned string must be freed using LocalFree


function DuplicateMultiWideString(AString:PWideChar):PWideChar;
Description: To be documented
Note The returned string must be freed using LocalFree


File functions

function IsRootDirectory(const Path:String):Boolean;
Description: To be documented
Note To be documented


function IsEightDotThree(const FileName:String):Boolean;
Description: To be documented
Note To be documented


function TruncateLongName(const FileName:String):String;
Description: To be documented
Note To be documented


function GenerateShortName(const FileName:String; AliasCount:Integer):String;
Description: To be documented
Note If AliasCount is less than 0 then dont generate the numeric tail


function GenerateShortNameEx(const FileName:String; AliasCount:Integer; Hash:Word; UseHash:Boolean):String;
Description: To be documented
Note If AliasCount is less than 0 then dont generate the numeric tail


function WildcardFileMatch(const FileName,Wildcard:String; CaseSensitive:Boolean):Boolean;
Description: To be documented
Note To be documented


function GetFileInfo(const FileName:String; var FileTime,FileSize:Integer; var FileAttr:LongWord):Boolean;
Description: To be documented
Note To be documented


function CompareFileInfo(const SourceFile,DestFile:String):Boolean;
Description: To be documented
Note To be documented


Return to Unit Reference