Return to Unit Reference
Description
Ultibo Utils unit
Constants
[Expand]
BoolToStr constants BOOLSTR_*
BOOLSTR_TRUEFALSE = 0;
|
|
BOOLSTR_YESNO = 1;
|
|
BOOLSTR_ZEROONE = 2;
|
|
Type definitions
None defined
Public variables
None defined
Function declarations
String functions
[Expand]
function GetFirstWord(var AValue:String; const ADelimiter:String):String;
Description: To be documented
[Expand]
function GetLastWord(var AValue:String; const ADelimiter:String):String;
Description: To be documented
[Expand]
function PadString(const AValue:String; AChar:Char;ALength:Integer):String;
Description: System StringOfChar may not handle Length < 0 correctly
[Expand]
function StrOfChar(const AValue:String; ALength:Integer):String;
Description: Use System StringOfChar instead
[Expand]
function StrToBool(const AValue:String):Boolean;
Description: To be documented
[Expand]
function IntToStrLen(AValue:Integer; ADigits:Integer):String;
Description: To be documented
[Expand]
function StrToLongWord(const AValue:String):LongWord;
Description: To be documented
[Expand]
function BoolToStr(AValue:Boolean):String;
Description: To be documented
[Expand]
function BoolToStrEx(AValue:Boolean; AType:Integer):String;
Description: To be documented
[Expand]
function InFixStr(const Value:String):String;
Description: To be documented
[Expand]
function InFixStrEx(const Value:String):String;
Description: To be documented
[Expand]
function RemoveSpaces(const Text:String):String;
Description: To be documented
[Expand]
function SpaceCount(const Text:String):Integer;
Description: To be documented
[Expand]
function NormaliseSpaces(const Text:String):String;
Description: To be documented
[Expand]
function NormaliseCase(const Text:String):String;
Description: To be documented
[Expand]
function StringFill(const Text:String; Count:Integer):String;
Description: To be documented
[Expand]
function RemoveQuotes(const AValue:String):String;
Description: To be documented
[Expand]
function RemoveBraces(const AValue:String):String;
Description: To be documented
[Expand]
function RemoveBrackets(const AValue:String):String;
Description: To be documented
[Expand]
function RemoveSingleQuotes(const AValue:String):String;
Description: To be documented
[Expand]
function RemoveCurlyBraces(const AValue:String):String;
Description: To be documented
[Expand]
function IsAlpha(const AValue:String):Boolean;
Description: To be documented
[Expand]
function IsNumeric(const AValue:String):Boolean;
Description: To be documented
[Expand]
function RemoveNonAlpha(const Value:String):String;
Description: To be documented
[Expand]
function AddQuotes(const AValue:String):String;
Description: To be documented
[Expand]
function AddBraces(const AValue:String):String;
Description: To be documented
[Expand]
function AddBrackets(const AValue:String):String;
Description: To be documented
[Expand]
function AddSingleQuotes(const AValue:String):String;
Description: To be documented
[Expand]
function AddCurlyBraces(const AValue:String):String;
Description: To be documented
[Expand]
function NoOfChars(const AValue:String; AChar:Char):Integer;
Description: To be documented
[Expand]
function ReplaceChar(const AValue:String; AChar,AReplace:Char):String;
Description: To be documented
[Expand]
function EncodeString(const AValue,AKey:String):String;
Description: To be documented
[Expand]
function DecodeString(const AValue,AKey:String):String;
Description: To be documented
[Expand]
procedure DelimitStrings(AStrings:TStrings; var AString:String; const ADelimiter:String);
Description: To be documented
[Expand]
procedure UndelimitString(const AString:String; AStrings:TStrings; const ADelimiter:String);
Description: To be documented
[Expand]
procedure UndelimitQuotedString(const AString:String; AStrings:TStrings; const ADelimiter:String);
Description: To be documented
[Expand]
function AddSlashes(const AFilePath:String):String;
Description: To be documented
[Expand]
function AddTrailingSlash(const AFilePath:String):String;
Description: To be documented
[Expand]
function AddLeadingSlash(const AFilePath:String):String;
Description: To be documented
[Expand]
function StripSlashes(const AFilePath:String):String;
Description: To be documented
[Expand]
function StripTrailingSlash(const AFilePath:String):String;
Description: To be documented
[Expand]
function StripLeadingSlash(const AFilePath:String):String;
Description: To be documented
[Expand]
function AddTrailingDot(const AValue:String):String;
Description: To be documented
[Expand]
function AddLeadingDot(const AValue:String):String;
Description: To be documented
[Expand]
function StripTrailingDot(const AValue:String):String;
Description: To be documented
[Expand]
function StripLeadingDot(const AValue:String):String;
Description: To be documented
[Expand]
function AddTrailingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
[Expand]
function AddLeadingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
[Expand]
function StripTrailingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
[Expand]
function StripLeadingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
[Expand]
function IsWildcard(const Value:String):Boolean;
Description: To be documented
[Expand]
function UniqueName(const BaseName:String; CurrentNames:TStrings):String;
Description: To be documented
[Expand]
function WildcardNameMatch(const Name,Wildcard:String; CaseSensitive:Boolean):Boolean;
Description: To be documented
[Expand]
function AddQuotesIfSpaced(const AValue:String):String;
Description: To be documented
[Expand]
function ExtractCommand(const ACommandLine:String):String;
Description: To be documented
[Expand]
function ExtractParameters(const ACommandLine:String):String;
Description: To be documented
[Expand]
function AllocateCommandLine(const ACommandLine:String; out AArgC:Integer):PPAnsiChar;
Description: Allocate a C style command line and return ArgC and ArgV in the correct format
| CommandLine
|
The command line to be formatted into C style ArgV and ArgC
|
| ArgC
|
The count of command line parameters in the result
|
[Expand]
procedure ReleaseCommandLine(AArgV:PPAnsiChar);
Description: Free a C command line allocated by AllocateCommandLine
| ArgV
|
The command line to be freed
|
[Expand]
function MultiStringToStrings(ABuffer:Pointer; ASize:Integer; AStrings:TStrings):Boolean;
Description: To be documented
[Expand]
function StringsToMultiString(AStrings:TStrings; var ABuffer:Pointer; var ASize:Integer):Boolean;
Description: To be documented
| Note
|
The returned buffer must be freed using FreeMem
|
[Expand]
function MultiStringToDelimited(ABuffer:PChar; ADelimiter:String):String;
Description: To be documented
[Expand]
function DelimitedToMultiString(const AString:String; ADelimiter:String):PChar;
Description: To be documented
| Note
|
The returned string must be freed using LocalFree
|
[Expand]
function DuplicateString(AString:PAnsiChar):PAnsiChar;
Description: To be documented
| Note
|
The returned string must be freed using LocalFree
|
[Expand]
function DuplicateWideString(AString:PWideChar):PWideChar;
Description: To be documented
| Note
|
The returned string must be freed using LocalFree
|
[Expand]
function DuplicateMultiString(AString:PAnsiChar):PAnsiChar;
Description: To be documented
| Note
|
The returned string must be freed using LocalFree
|
[Expand]
function DuplicateMultiWideString(AString:PWideChar):PWideChar;
Description: To be documented
| Note
|
The returned string must be freed using LocalFree
|
File functions
[Expand]
function IsRootDirectory(const Path:String):Boolean;
Description: To be documented
[Expand]
function IsEightDotThree(const FileName:String):Boolean;
Description: To be documented
[Expand]
function TruncateLongName(const FileName:String):String;
Description: To be documented
[Expand]
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
|
[Expand]
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
|
[Expand]
function WildcardFileMatch(const FileName,Wildcard:String; CaseSensitive:Boolean):Boolean;
Description: To be documented
[Expand]
function GetFileInfo(const FileName:String; var FileTime,FileSize:Integer; var FileAttr:LongWord):Boolean;
Description: To be documented
[Expand]
function CompareFileInfo(const SourceFile,DestFile:String):Boolean;
Description: To be documented
Date functions
[Expand]
function IsCurrentDate(ADate:TDateTime):Boolean;
Description: To be documented
[Expand]
function IsCurrentTime(ATime:TDateTime):Boolean;
Description: To be documented
[Expand]
function IsCurrentMinute(AMinute:Integer):Boolean;
Description: To be documented
[Expand]
function IsCurrentHour(AHour:Integer):Boolean;
Description: To be documented
[Expand]
function IsCurrentWeekDay(AWeekDay:Integer):Boolean;
Description: To be documented
[Expand]
function IsCurrentDay(ADay:Integer):Boolean;
Description: To be documented
[Expand]
function IsCurrentMonth(AMonth:Integer):Boolean;
Description: To be documented
[Expand]
function IsCurrentYear(AYear:Integer):Boolean;
Description: To be documented
[Expand]
function GetMinute(ADateTime:TDateTime):Integer;
Description: To be documented
[Expand]
function GetHour(ADateTime:TDateTime):Integer;
Description: To be documented
[Expand]
function GetWeekday(ADateTime:TDateTime):Integer;
Description: To be documented
[Expand]
function GetDay(ADateTime:TDateTime):Integer;
Description: To be documented
[Expand]
function GetMonth(ADateTime:TDateTime):Integer;
Description: To be documented
[Expand]
function GetYear(ADateTime:TDateTime):Integer;
Description: To be documented
[Expand]
function SecondsSince(ADateTime:TDateTime):LongWord;
Description: To be documented
[Expand]
function MinutesSince(ADateTime:TDateTime):LongWord;
Description: To be documented
[Expand]
function HoursSince(ADateTime:TDateTime):LongWord;
Description: To be documented
[Expand]
function DaysSince(ADateTime:TDateTime):LongWord;
Description: To be documented
[Expand]
function MonthsSince(ADateTime:TDateTime):LongWord;
Description: To be documented
[Expand]
function YearsSince(ADateTime:TDateTime):LongWord;
Description: To be documented
[Expand]
function DayOfYear(ADateTime:TDateTime):LongWord;
Description: To be documented
[Expand]
function SubtractSeconds(ADateTime:TDateTime; ASeconds:LongWord):TDateTime;
Description: To be documented
[Expand]
function TickCount:LongWord;
Description: Returns number of milliseconds since Ultibo started using GetTickCount
[Expand]
function NormaliseDate(const ADate:String):String;
Description: To be documented
[Expand]
function FormatEmailDate(ADateTime:TDateTime):String;
Description: To be documented
[Expand]
function ShortMonthToMonth(const AShortMonth:String):LongWord;
Description: To be documented
[Expand]
function LongMonthToMonth(const ALongMonth:String):LongWord;
Description: To be documented
[Expand]
function TwoDigitYearToYear(AYear:LongWord):LongWord;
Description: To be documented
Network functions
[Expand]
function CheckEmailAddress(const EmailAddress:String):Boolean;
Description: To be documented
[Expand]
function StripEmailAddress(const EmailAddress:String):String;
Description: To be documented
[Expand]
function FormatEmailAddress(const FullName,EmailAddress:String):String;
Description: To be documented
[Expand]
function GetUserFromEmail(const EmailAddress:String):String;
Description: To be documented
[Expand]
function GetDomainFromEmail(const EmailAddress:String):String;
Description: To be documented
Miscellaneous functions
[Expand]
function CloneSid(ASid:Pointer):Pointer;
Description: To be documented
[Expand]
function CloneDescriptor(ADescriptor:Pointer):Pointer;
Description: To be documented
[Expand]
function CompareSid(ASid1,ASid2:Pointer):Boolean;
Description: Caller should first compare the Hashes
[Expand]
function CompareDescriptor(ADescriptor1,ADescriptor2:Pointer):Boolean;
Description: Caller should first compare the Hashes
[Expand]
function GenerateSidHash(ASid:Pointer; ASize:LongWord):LongWord;
Description: To be documented
[Expand]
function GenerateDescriptorHash(ADescriptor:Pointer; ASize:LongWord):LongWord;
Description: To be documented
Return to Unit Reference
