Difference between revisions of "Unit UltiboUtils"

From Ultibo.org
Jump to: navigation, search
Line 53: Line 53:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 65: Line 65:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 77: Line 77:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 89: Line 89:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 101: Line 101:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 113: Line 113:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 125: Line 125:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 137: Line 137:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 149: Line 149:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 161: Line 161:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 173: Line 173:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 185: Line 185:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 197: Line 197:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 209: Line 209:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 221: Line 221:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 233: Line 233:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 245: Line 245:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 257: Line 257:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 269: Line 269:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 281: Line 281:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 293: Line 293:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 305: Line 305:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 317: Line 317:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 329: Line 329:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 341: Line 341:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 353: Line 353:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 365: Line 365:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 377: Line 377:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 389: Line 389:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 401: Line 401:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 413: Line 413:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 425: Line 425:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 437: Line 437:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 449: Line 449:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 461: Line 461:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 473: Line 473:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 485: Line 485:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 497: Line 497:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 509: Line 509:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 521: Line 521:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 533: Line 533:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 545: Line 545:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 557: Line 557:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 569: Line 569:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 581: Line 581:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 593: Line 593:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 605: Line 605:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 617: Line 617:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 629: Line 629:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 641: Line 641:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 653: Line 653:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 665: Line 665:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 677: Line 677:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 689: Line 689:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 701: Line 701:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 713: Line 713:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 725: Line 725:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''CommandLine'''
+
! CommandLine
 
| The command line to be formatted into C style ArgV and ArgC
 
| The command line to be formatted into C style ArgV and ArgC
 
|-
 
|-
! '''ArgC'''
+
! ArgC
 
| The count of command line parameters in the result
 
| The count of command line parameters in the result
 
|-
 
|-
Line 740: Line 740:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''ArgV'''
+
! ArgV
 
| The command line to be freed
 
| The command line to be freed
 
|-
 
|-
Line 752: Line 752:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 764: Line 764:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| The returned buffer must be freed using FreeMem
 
| The returned buffer must be freed using FreeMem
 
|-
 
|-
Line 776: Line 776:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 788: Line 788:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| The returned string must be freed using LocalFree
 
| The returned string must be freed using LocalFree
 
|-
 
|-
Line 800: Line 800:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| The returned string must be freed using LocalFree
 
| The returned string must be freed using LocalFree
 
|-
 
|-
Line 812: Line 812:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| The returned string must be freed using LocalFree
 
| The returned string must be freed using LocalFree
 
|-
 
|-
Line 824: Line 824:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| The returned string must be freed using LocalFree
 
| The returned string must be freed using LocalFree
 
|-
 
|-
Line 836: Line 836:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| The returned string must be freed using LocalFree
 
| The returned string must be freed using LocalFree
 
|-
 
|-
Line 851: Line 851:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 863: Line 863:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 875: Line 875:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 887: Line 887:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! 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 899: Line 899:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! 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 911: Line 911:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 923: Line 923:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 935: Line 935:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 950: Line 950:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 962: Line 962:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 974: Line 974:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 986: Line 986:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 998: Line 998:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,010: Line 1,010:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,022: Line 1,022:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,034: Line 1,034:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,046: Line 1,046:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,058: Line 1,058:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,070: Line 1,070:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,082: Line 1,082:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,094: Line 1,094:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,106: Line 1,106:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,118: Line 1,118:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,130: Line 1,130:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,142: Line 1,142:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,154: Line 1,154:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,166: Line 1,166:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,178: Line 1,178:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,190: Line 1,190:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,202: Line 1,202:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,214: Line 1,214:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,226: Line 1,226:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,238: Line 1,238:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,250: Line 1,250:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,262: Line 1,262:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,274: Line 1,274:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,289: Line 1,289:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,301: Line 1,301:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,313: Line 1,313:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,325: Line 1,325:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,337: Line 1,337:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,352: Line 1,352:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,364: Line 1,364:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,376: Line 1,376:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,388: Line 1,388:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,400: Line 1,400:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,412: Line 1,412:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-

Revision as of 00:33, 20 April 2018

Return to Unit Reference


Description


Ultibo utils unit

To be documented

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):PPChar;
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:PPChar);
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: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 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