Difference between revisions of "Unit UltiboUtils"
From Ultibo.org
| (14 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
---- | ---- | ||
| − | '' | + | '''Ultibo Utils unit''' |
=== Constants === | === Constants === | ||
---- | ---- | ||
| − | '' | + | |
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;"> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''BoolToStr constants''' <code> BOOLSTR_* </code></div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | | <code>BOOLSTR_TRUEFALSE = 0;</code> | ||
| + | | style="width: 50%;"| | ||
| + | |- | ||
| + | | <code>BOOLSTR_YESNO = 1;</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>BOOLSTR_ZEROONE = 2;</code> | ||
| + | | | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
=== Type definitions === | === Type definitions === | ||
---- | ---- | ||
| − | '' | + | ''None defined'' |
=== Public variables === | === Public variables === | ||
---- | ---- | ||
| − | '' | + | ''None defined'' |
=== Function declarations === | === Function declarations === | ||
| Line 29: | Line 46: | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <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 GetFirstWord(var AValue:String; ADelimiter:String):String;</pre> | + | <pre style="border: 0; padding-bottom:0px;">function GetFirstWord(var AValue:String; const ADelimiter:String):String;</pre> |
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <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;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 41: | Line 58: | ||
<br /> | <br /> | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <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 GetLastWord(var AValue:String; ADelimiter:String):String;</pre> | + | <pre style="border: 0; padding-bottom:0px;">function GetLastWord(var AValue:String; const ADelimiter:String):String;</pre> |
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <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;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 58: | Line 75: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 70: | Line 87: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 82: | Line 99: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 94: | Line 111: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 106: | Line 123: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 118: | Line 135: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 130: | Line 147: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 142: | Line 159: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 154: | Line 171: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 166: | Line 183: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 178: | Line 195: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 190: | Line 207: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 202: | Line 219: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 214: | Line 231: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 226: | Line 243: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 238: | Line 255: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 250: | Line 267: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 262: | Line 279: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 274: | Line 291: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 286: | Line 303: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 298: | Line 315: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 310: | Line 327: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 322: | Line 339: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 334: | Line 351: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 346: | Line 363: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 358: | Line 375: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 370: | Line 387: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 382: | Line 399: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 394: | Line 411: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 406: | Line 423: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 418: | Line 435: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 430: | Line 447: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 437: | Line 454: | ||
<br /> | <br /> | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <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 UndelimitString(AString:String; AStrings:TStrings; const ADelimiter:String);</pre> | + | <pre style="border: 0; padding-bottom:0px;">procedure UndelimitString(const AString:String; AStrings:TStrings; const ADelimiter:String);</pre> |
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <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;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 449: | Line 466: | ||
<br /> | <br /> | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <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 UndelimitQuotedString(AString:String; AStrings:TStrings; const ADelimiter:String);</pre> | + | <pre style="border: 0; padding-bottom:0px;">procedure UndelimitQuotedString(const AString:String; AStrings:TStrings; const ADelimiter:String);</pre> |
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <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;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 466: | Line 483: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 478: | Line 495: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 490: | Line 507: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 502: | Line 519: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 514: | Line 531: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 526: | Line 543: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 538: | Line 555: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 550: | Line 567: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 562: | Line 579: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 574: | Line 591: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 586: | Line 603: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 598: | Line 615: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 610: | Line 627: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 622: | Line 639: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 634: | Line 651: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 646: | Line 663: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 658: | Line 675: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 670: | Line 687: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 682: | Line 699: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 694: | Line 711: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| 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 AllocateCommandLine(const ACommandLine:String; out AArgC:Integer):PPAnsiChar;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Allocate a C style command line and return ArgC and ArgV in the correct format</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! CommandLine | ||
| + | | The command line to be formatted into C style ArgV and ArgC | ||
| + | |- | ||
| + | ! ArgC | ||
| + | | The count of command line parameters in the result | ||
| + | |- | ||
| + | |} | ||
| + | </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 ReleaseCommandLine(AArgV:PPAnsiChar);</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Free a C command line allocated by AllocateCommandLine</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! ArgV | ||
| + | | The command line to be freed | ||
|- | |- | ||
|} | |} | ||
| Line 706: | Line 750: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 718: | Line 762: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| The returned buffer must be freed using FreeMem | | The returned buffer must be freed using FreeMem | ||
|- | |- | ||
| Line 730: | Line 774: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 742: | Line 786: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| The returned string must be freed using LocalFree | | The returned string must be freed using LocalFree | ||
|- | |- | ||
| Line 749: | Line 793: | ||
<br /> | <br /> | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <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 DuplicateString(AString: | + | <pre style="border: 0; padding-bottom:0px;">function DuplicateString(AString:PAnsiChar):PAnsiChar;</pre> |
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <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;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| The returned string must be freed using LocalFree | | The returned string must be freed using LocalFree | ||
|- | |- | ||
| Line 766: | Line 810: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| The returned string must be freed using LocalFree | | The returned string must be freed using LocalFree | ||
|- | |- | ||
| Line 773: | Line 817: | ||
<br /> | <br /> | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <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 DuplicateMultiString(AString: | + | <pre style="border: 0; padding-bottom:0px;">function DuplicateMultiString(AString:PAnsiChar):PAnsiChar;</pre> |
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <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;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| The returned string must be freed using LocalFree | | The returned string must be freed using LocalFree | ||
|- | |- | ||
| Line 790: | Line 834: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| The returned string must be freed using LocalFree | | The returned string must be freed using LocalFree | ||
|- | |- | ||
| Line 805: | Line 849: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 817: | Line 861: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 829: | Line 873: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 841: | Line 885: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| If AliasCount is less than 0 then dont generate the numeric tail | | If AliasCount is less than 0 then dont generate the numeric tail | ||
|- | |- | ||
| Line 853: | Line 897: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| If AliasCount is less than 0 then dont generate the numeric tail | | If AliasCount is less than 0 then dont generate the numeric tail | ||
|- | |- | ||
| Line 865: | Line 909: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 877: | Line 921: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| − | | | + | | None documented |
|- | |- | ||
|} | |} | ||
| Line 889: | Line 933: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! '''Note''' | + | ! Note |
| − | | To be documented | + | | None documented |
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | |||
| + | '''Date 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 IsCurrentDate(ADate:TDateTime):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 IsCurrentTime(ATime:TDateTime):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 IsCurrentMinute(AMinute:Integer):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 IsCurrentHour(AHour:Integer):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 IsCurrentWeekDay(AWeekDay:Integer):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 IsCurrentDay(ADay:Integer):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 IsCurrentMonth(AMonth:Integer):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 IsCurrentYear(AYear:Integer):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 GetMinute(ADateTime:TDateTime):Integer;</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 GetHour(ADateTime:TDateTime):Integer;</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 GetWeekday(ADateTime:TDateTime):Integer;</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 GetDay(ADateTime:TDateTime):Integer;</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 GetMonth(ADateTime:TDateTime):Integer;</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 GetYear(ADateTime:TDateTime):Integer;</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 SecondsSince(ADateTime:TDateTime):LongWord;</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 MinutesSince(ADateTime:TDateTime):LongWord;</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 HoursSince(ADateTime:TDateTime):LongWord;</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 DaysSince(ADateTime:TDateTime):LongWord;</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 MonthsSince(ADateTime:TDateTime):LongWord;</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 YearsSince(ADateTime:TDateTime):LongWord;</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 DayOfYear(ADateTime:TDateTime):LongWord;</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 SubtractSeconds(ADateTime:TDateTime; ASeconds:LongWord):TDateTime;</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 TickCount:LongWord;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Returns number of milliseconds since Ultibo started using GetTickCount</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 NormaliseDate(const ADate: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 | ||
| + | | 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 FormatEmailDate(ADateTime:TDateTime):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;">function ShortMonthToMonth(const AShortMonth:String):LongWord;</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 LongMonthToMonth(const ALongMonth:String):LongWord;</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 TwoDigitYearToYear(AYear:LongWord):LongWord;</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 /> | ||
| + | |||
| + | '''Network 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 CheckEmailAddress(const EmailAddress: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 | ||
| + | | 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 StripEmailAddress(const EmailAddress: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 | ||
| + | | 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 FormatEmailAddress(const FullName,EmailAddress: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 | ||
| + | | 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 GetUserFromEmail(const EmailAddress: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 | ||
| + | | 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 GetDomainFromEmail(const EmailAddress: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 | ||
| + | | None documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | |||
| + | '''Miscellaneous 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 CloneSid(ASid:Pointer):Pointer;</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 CloneDescriptor(ADescriptor:Pointer):Pointer;</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 CompareSid(ASid1,ASid2:Pointer):Boolean;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Caller should first compare the Hashes</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 CompareDescriptor(ADescriptor1,ADescriptor2:Pointer):Boolean;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Caller should first compare the Hashes</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 GenerateSidHash(ASid:Pointer; ASize:LongWord):LongWord;</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 GenerateDescriptorHash(ADescriptor:Pointer; ASize:LongWord):LongWord;</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 | ||
|- | |- | ||
|} | |} | ||
Latest revision as of 03:55, 12 September 2024
Return to Unit Reference
Description
Ultibo Utils unit
Constants
BoolToStr constants
BOOLSTR_* BOOLSTR_TRUEFALSE = 0;
|
|
BOOLSTR_YESNO = 1;
|
|
BOOLSTR_ZEROONE = 2;
|
Type definitions
None defined
Public variables
None defined
Function declarations
String functions
function GetFirstWord(var AValue:String; const ADelimiter:String):String;
Description: To be documented
| Note | None documented |
|---|
function GetLastWord(var AValue:String; const ADelimiter:String):String;
Description: To be documented
| Note | None documented |
|---|
function PadString(const AValue:String; AChar:Char;ALength:Integer):String;
Description: System StringOfChar may not handle Length < 0 correctly
| Note | None documented |
|---|
function StrOfChar(const AValue:String; ALength:Integer):String;
Description: Use System StringOfChar instead
| Note | None documented |
|---|
function StrToBool(const AValue:String):Boolean;
Description: To be documented
| Note | None documented |
|---|
function IntToStrLen(AValue:Integer; ADigits:Integer):String;
Description: To be documented
| Note | None documented |
|---|
function StrToLongWord(const AValue:String):LongWord;
Description: To be documented
| Note | None documented |
|---|
function BoolToStr(AValue:Boolean):String;
Description: To be documented
| Note | None documented |
|---|
function BoolToStrEx(AValue:Boolean; AType:Integer):String;
Description: To be documented
| Note | None documented |
|---|
function InFixStr(const Value:String):String;
Description: To be documented
| Note | None documented |
|---|
function InFixStrEx(const Value:String):String;
Description: To be documented
| Note | None documented |
|---|
function RemoveSpaces(const Text:String):String;
Description: To be documented
| Note | None documented |
|---|
function SpaceCount(const Text:String):Integer;
Description: To be documented
| Note | None documented |
|---|
function NormaliseSpaces(const Text:String):String;
Description: To be documented
| Note | None documented |
|---|
function NormaliseCase(const Text:String):String;
Description: To be documented
| Note | None documented |
|---|
function StringFill(const Text:String; Count:Integer):String;
Description: To be documented
| Note | None documented |
|---|
function RemoveQuotes(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function RemoveBraces(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function RemoveBrackets(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function RemoveSingleQuotes(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function RemoveCurlyBraces(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function IsAlpha(const AValue:String):Boolean;
Description: To be documented
| Note | None documented |
|---|
function IsNumeric(const AValue:String):Boolean;
Description: To be documented
| Note | None documented |
|---|
function RemoveNonAlpha(const Value:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddQuotes(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddBraces(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddBrackets(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddSingleQuotes(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddCurlyBraces(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function NoOfChars(const AValue:String; AChar:Char):Integer;
Description: To be documented
| Note | None documented |
|---|
function ReplaceChar(const AValue:String; AChar,AReplace:Char):String;
Description: To be documented
| Note | None documented |
|---|
function EncodeString(const AValue,AKey:String):String;
Description: To be documented
| Note | None documented |
|---|
function DecodeString(const AValue,AKey:String):String;
Description: To be documented
| Note | None documented |
|---|
procedure DelimitStrings(AStrings:TStrings; var AString:String; const ADelimiter:String);
Description: To be documented
| Note | None documented |
|---|
procedure UndelimitString(const AString:String; AStrings:TStrings; const ADelimiter:String);
Description: To be documented
| Note | None documented |
|---|
procedure UndelimitQuotedString(const AString:String; AStrings:TStrings; const ADelimiter:String);
Description: To be documented
| Note | None documented |
|---|
function AddSlashes(const AFilePath:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddTrailingSlash(const AFilePath:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddLeadingSlash(const AFilePath:String):String;
Description: To be documented
| Note | None documented |
|---|
function StripSlashes(const AFilePath:String):String;
Description: To be documented
| Note | None documented |
|---|
function StripTrailingSlash(const AFilePath:String):String;
Description: To be documented
| Note | None documented |
|---|
function StripLeadingSlash(const AFilePath:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddTrailingDot(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddLeadingDot(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function StripTrailingDot(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function StripLeadingDot(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddTrailingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
| Note | None documented |
|---|
function AddLeadingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
| Note | None documented |
|---|
function StripTrailingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
| Note | None documented |
|---|
function StripLeadingChar(const AFilePath,ASlashChar:String):String;
Description: To be documented
| Note | None documented |
|---|
function IsWildcard(const Value:String):Boolean;
Description: To be documented
| Note | None documented |
|---|
function UniqueName(const BaseName:String; CurrentNames:TStrings):String;
Description: To be documented
| Note | None documented |
|---|
function WildcardNameMatch(const Name,Wildcard:String; CaseSensitive:Boolean):Boolean;
Description: To be documented
| Note | None documented |
|---|
function AddQuotesIfSpaced(const AValue:String):String;
Description: To be documented
| Note | None documented |
|---|
function ExtractCommand(const ACommandLine:String):String;
Description: To be documented
| Note | None documented |
|---|
function ExtractParameters(const ACommandLine:String):String;
Description: To be documented
| Note | None documented |
|---|
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 |
procedure ReleaseCommandLine(AArgV:PPAnsiChar);
Description: Free a C command line allocated by AllocateCommandLine
| ArgV | The command line to be freed |
|---|
function MultiStringToStrings(ABuffer:Pointer; ASize:Integer; AStrings:TStrings):Boolean;
Description: To be documented
| Note | None 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 | None 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:PAnsiChar):PAnsiChar;
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:PAnsiChar):PAnsiChar;
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 | None documented |
|---|
function IsEightDotThree(const FileName:String):Boolean;
Description: To be documented
| Note | None documented |
|---|
function TruncateLongName(const FileName:String):String;
Description: To be documented
| Note | None 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 | None documented |
|---|
function GetFileInfo(const FileName:String; var FileTime,FileSize:Integer; var FileAttr:LongWord):Boolean;
Description: To be documented
| Note | None documented |
|---|
function CompareFileInfo(const SourceFile,DestFile:String):Boolean;
Description: To be documented
| Note | None documented |
|---|
Date functions
function IsCurrentDate(ADate:TDateTime):Boolean;
Description: To be documented
| Note | None documented |
|---|
function IsCurrentTime(ATime:TDateTime):Boolean;
Description: To be documented
| Note | None documented |
|---|
function IsCurrentMinute(AMinute:Integer):Boolean;
Description: To be documented
| Note | None documented |
|---|
function IsCurrentHour(AHour:Integer):Boolean;
Description: To be documented
| Note | None documented |
|---|
function IsCurrentWeekDay(AWeekDay:Integer):Boolean;
Description: To be documented
| Note | None documented |
|---|
function IsCurrentDay(ADay:Integer):Boolean;
Description: To be documented
| Note | None documented |
|---|
function IsCurrentMonth(AMonth:Integer):Boolean;
Description: To be documented
| Note | None documented |
|---|
function IsCurrentYear(AYear:Integer):Boolean;
Description: To be documented
| Note | None documented |
|---|
function GetMinute(ADateTime:TDateTime):Integer;
Description: To be documented
| Note | None documented |
|---|
function GetHour(ADateTime:TDateTime):Integer;
Description: To be documented
| Note | None documented |
|---|
function GetWeekday(ADateTime:TDateTime):Integer;
Description: To be documented
| Note | None documented |
|---|
function GetDay(ADateTime:TDateTime):Integer;
Description: To be documented
| Note | None documented |
|---|
function GetMonth(ADateTime:TDateTime):Integer;
Description: To be documented
| Note | None documented |
|---|
function GetYear(ADateTime:TDateTime):Integer;
Description: To be documented
| Note | None documented |
|---|
function SecondsSince(ADateTime:TDateTime):LongWord;
Description: To be documented
| Note | None documented |
|---|
function MinutesSince(ADateTime:TDateTime):LongWord;
Description: To be documented
| Note | None documented |
|---|
function HoursSince(ADateTime:TDateTime):LongWord;
Description: To be documented
| Note | None documented |
|---|
function DaysSince(ADateTime:TDateTime):LongWord;
Description: To be documented
| Note | None documented |
|---|
function MonthsSince(ADateTime:TDateTime):LongWord;
Description: To be documented
| Note | None documented |
|---|
function YearsSince(ADateTime:TDateTime):LongWord;
Description: To be documented
| Note | None documented |
|---|
function DayOfYear(ADateTime:TDateTime):LongWord;
Description: To be documented
| Note | None documented |
|---|
function SubtractSeconds(ADateTime:TDateTime; ASeconds:LongWord):TDateTime;
Description: To be documented
| Note | None documented |
|---|
function TickCount:LongWord;
Description: Returns number of milliseconds since Ultibo started using GetTickCount
| Note | None documented |
|---|
function NormaliseDate(const ADate:String):String;
Description: To be documented
| Note | None documented |
|---|
function FormatEmailDate(ADateTime:TDateTime):String;
Description: To be documented
| Note | None documented |
|---|
function ShortMonthToMonth(const AShortMonth:String):LongWord;
Description: To be documented
| Note | None documented |
|---|
function LongMonthToMonth(const ALongMonth:String):LongWord;
Description: To be documented
| Note | None documented |
|---|
function TwoDigitYearToYear(AYear:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
Network functions
function CheckEmailAddress(const EmailAddress:String):Boolean;
Description: To be documented
| Note | None documented |
|---|
function StripEmailAddress(const EmailAddress:String):String;
Description: To be documented
| Note | None documented |
|---|
function FormatEmailAddress(const FullName,EmailAddress:String):String;
Description: To be documented
| Note | None documented |
|---|
function GetUserFromEmail(const EmailAddress:String):String;
Description: To be documented
| Note | None documented |
|---|
function GetDomainFromEmail(const EmailAddress:String):String;
Description: To be documented
| Note | None documented |
|---|
Miscellaneous functions
function CloneSid(ASid:Pointer):Pointer;
Description: To be documented
| Note | None documented |
|---|
function CloneDescriptor(ADescriptor:Pointer):Pointer;
Description: To be documented
| Note | None documented |
|---|
function CompareSid(ASid1,ASid2:Pointer):Boolean;
Description: Caller should first compare the Hashes
| Note | None documented |
|---|
function CompareDescriptor(ADescriptor1,ADescriptor2:Pointer):Boolean;
Description: Caller should first compare the Hashes
| Note | None documented |
|---|
function GenerateSidHash(ASid:Pointer; ASize:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
function GenerateDescriptorHash(ADescriptor:Pointer; ASize:LongWord):LongWord;
Description: To be documented
| Note | None documented |
|---|
Return to Unit Reference
