Unit UltiboUtils

From Ultibo.org
Revision as of 04:27, 9 September 2016 by Ultibo (Talk | contribs)

Jump to: navigation, search

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


Date functions

function IsCurrentDate(ADate:TDateTime):Boolean;
Description: To be documented
Note To be documented


function IsCurrentTime(ATime:TDateTime):Boolean;
Description: To be documented
Note To be documented


function IsCurrentMinute(AMinute:Integer):Boolean;
Description: To be documented
Note To be documented


function IsCurrentHour(AHour:Integer):Boolean;
Description: To be documented
Note To be documented


function IsCurrentWeekDay(AWeekDay:Integer):Boolean;
Description: To be documented
Note To be documented


function IsCurrentDay(ADay:Integer):Boolean;
Description: To be documented
Note To be documented


function IsCurrentMonth(AMonth:Integer):Boolean;
Description: To be documented
Note To be documented


function IsCurrentYear(AYear:Integer):Boolean;
Description: To be documented
Note To be documented


function GetMinute(ADateTime:TDateTime):Integer;
Description: To be documented
Note To be documented


function GetHour(ADateTime:TDateTime):Integer;
Description: To be documented
Note To be documented


function GetWeekday(ADateTime:TDateTime):Integer;
Description: To be documented
Note To be documented


function GetDay(ADateTime:TDateTime):Integer;
Description: To be documented
Note To be documented


function GetMonth(ADateTime:TDateTime):Integer;
Description: To be documented
Note To be documented


function GetYear(ADateTime:TDateTime):Integer;
Description: To be documented
Note To be documented


function SecondsSince(ADateTime:TDateTime):LongWord;
Description: To be documented
Note To be documented


function MinutesSince(ADateTime:TDateTime):LongWord;
Description: To be documented
Note To be documented


function HoursSince(ADateTime:TDateTime):LongWord;
Description: To be documented
Note To be documented


function DaysSince(ADateTime:TDateTime):LongWord;
Description: To be documented
Note To be documented


function MonthsSince(ADateTime:TDateTime):LongWord;
Description: To be documented
Note To be documented


function YearsSince(ADateTime:TDateTime):LongWord;
Description: To be documented
Note To be documented


function DayOfYear(ADateTime:TDateTime):LongWord;
Description: To be documented
Note To be documented


function SubtractSeconds(ADateTime:TDateTime; ASeconds:LongWord):TDateTime;
Description: To be documented
Note To be documented


function TickCount:LongWord;
Description: Returns number of milliseconds since Ultibo started using GetTickCount
Note To be documented


function NormaliseDate(const ADate:String):String;
Description: To be documented
Note To be documented


function FormatEmailDate(ADateTime:TDateTime):String;
Description: To be documented
Note To be documented


function ShortMonthToMonth(const AShortMonth:String):LongWord;
Description: To be documented
Note To be documented


function LongMonthToMonth(const ALongMonth:String):LongWord;
Description: To be documented
Note To be documented


function TwoDigitYearToYear(AYear:LongWord):LongWord;
Description: To be documented
Note To be documented


Network functions

function CheckEmailAddress(const EmailAddress:String):Boolean;
Description: To be documented
Note To be documented


function StripEmailAddress(const EmailAddress:String):String;
Description: To be documented
Note To be documented


function FormatEmailAddress(const FullName,EmailAddress:String):String;
Description: To be documented
Note To be documented


function GetUserFromEmail(const EmailAddress:String):String;
Description: To be documented
Note To be documented


function GetDomainFromEmail(const EmailAddress:String):String;
Description: To be documented
Note To be documented


Misc functions

function CloneSid(ASid:Pointer):Pointer;
Description: To be documented
Note To be documented


function CloneDescriptor(ADescriptor:Pointer):Pointer;
Description: To be documented
Note To be documented


function CompareSid(ASid1,ASid2:Pointer):Boolean;
Description: Caller should first compare the Hashes
Note To be documented


function CompareDescriptor(ADescriptor1,ADescriptor2:Pointer):Boolean;
Description: Caller should first compare the Hashes
Note To be documented


function GenerateSidHash(ASid:Pointer; ASize:LongWord):LongWord;
Description: To be documented
Note To be documented


function GenerateDescriptorHash(ADescriptor:Pointer; ASize:LongWord):LongWord;
Description: To be documented
Note To be documented


Return to Unit Reference