Difference between revisions of "Unit Ultibo"
From Ultibo.org
								
												
				| Line 330: | Line 330: | ||
! '''Note'''  | ! '''Note'''  | ||
| To be documented  | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | |||
| + | '''Time functions (Compatibility)'''  | ||
| + | |||
| + | <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 GetTickCount:DWORD;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function GetTickCount64:ULONGLONG;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">procedure GetSystemTime(var lpSystemTime:SYSTEMTIME);</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current system time in UTC</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">procedure GetSystemTimeAsFileTime(var lpSystemTimeAsFileTime:FILETIME);</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current system time in UTC as a FileTime value</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function SetSystemTime(var lpSystemTime:SYSTEMTIME):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the current system time in UTC</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">procedure GetLocalTime(var lpSystemTime:SYSTEMTIME);</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current local time</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function SetLocalTime(var lpSystemTime:SYSTEMTIME):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the current local time</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function SystemTimeToTzSpecificLocalTime(lpTimeZoneInformation:LPTIME_ZONE_INFORMATION; var lpUniversalTime,lpLocalTime:SYSTEMTIME):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function TzSpecificLocalTimeToSystemTime(const lpTimeZoneInformation:TIME_ZONE_INFORMATION; const lpLocalTime:SYSTEMTIME; var lpUniversalTime:SYSTEMTIME):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function GetTimeZoneInformation(var lpTimeZoneInformation:TIME_ZONE_INFORMATION):DWORD;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function SetTimeZoneInformation(const lpTimeZoneInformation:TIME_ZONE_INFORMATION):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function SystemTimeToFileTime(const lpSystemTime:SYSTEMTIME; var lpFileTime:FILETIME):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a SystemTime value to a FileTime value</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | lpSystemTime is assumed to be UTC / lpFileTime is returned as UTC  | ||
| + | |-  | ||
| + | |}  | ||
| + | </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 FileTimeToSystemTime(const lpFileTime:FILETIME; var lpSystemTime:SYSTEMTIME):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a FileTime value to a SystemTime value</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | lpFileTime is assumed to be UTC / lpSystemTime is returned as UTC. If lpFileTime is less than 30/12/1899 then SystemTime will be zero.  | ||
| + | |-  | ||
| + | |}  | ||
| + | </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 FileTimeToLocalFileTime(const lpFileTime:FILETIME; var lpLocalFileTime:FILETIME):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a FileTime in UTC to a FileTime in Local time</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | TIMEZONE_TIME_OFFSET is the number of minutes offset from UTC  | ||
| + | |-  | ||
| + | |}  | ||
| + | </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 LocalFileTimeToFileTime(const lpLocalFileTime:FILETIME; var lpFileTime:FILETIME):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a FileTime in Local time to a FileTime in UTC</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | TIMEZONE_TIME_OFFSET is the number of minutes offset from UTC  | ||
| + | |-  | ||
| + | |}  | ||
| + | </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 CompareFileTime(const lpFileTime1,lpFileTime2:FILETIME):LONG;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | To be documented  | ||
| + | |-  | ||
| + | |}  | ||
| + | </div></div>  | ||
| + | <br />  | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">  | ||
| + | <pre style="border: 0; padding-bottom:0px;">function FileTimeToDosDateTime(const lpFileTime:FILETIME; var lpFatDate,lpFatTime:WORD):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a FileTime value to a DOS date and time value</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | FileTime is assumed to be Local / DOS data and time is returned as Local. If FileTime is less than 1/1/1980 then DOS date and time will be zero.  | ||
| + | |-  | ||
| + | |}  | ||
| + | </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 DosDateTimeToFileTime(wFatDate,wFatTime:WORD; var lpFileTime:FILETIME):BOOL;</pre>  | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a DOS date and time value to a FileTime value</div>  | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">  | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;"  | ||
| + | |-  | ||
| + | ! '''Note'''  | ||
| + | | DOS date and time is assumed to be Local / FileTime is returned as Local. If DOS date and time is less than 1/1/1980 then FileTime will be zero.  | ||
|-  | |-  | ||
|}  | |}  | ||
Revision as of 07:22, 9 September 2016
Return to Unit Reference
Description
To be documented
Constants
To be documented
Type definitions
To be documented
Public variables
To be documented
Function declarations
Initialization functions
procedure UltiboInit;
Description: To be documented
| Note | To be documented | 
|---|
General functions (Compatibility)
function GetVersion:DWORD;
Description: To be documented
| Note | To be documented | 
|---|
function GetVersionEx(lpVersionInformation:LPOSVERSIONINFOA):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function GetVersionExA(lpVersionInformation:LPOSVERSIONINFOA):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function GetVersionExW(lpVersionInformation:LPOSVERSIONINFOW):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
procedure GetSystemInfo(var lpSystemInfo:SYSTEM_INFO);
Description: To be documented
| Note | To be documented | 
|---|
procedure GetNativeSystemInfo(lpSystemInfo:LPSYSTEM_INFO);
Description: To be documented
| Note | To be documented | 
|---|
function GetLargePageMinimum:SIZE_T;
Description: To be documented
| Note | To be documented | 
|---|
function GetComputerName(lpBuffer:LPSTR; var nSize:DWORD):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function GetComputerNameA(lpBuffer:LPSTR; var nSize:DWORD):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function GetComputerNameW(lpBuffer:LPWSTR; var nSize:DWORD):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function SetComputerName(lpComputerName:LPCSTR):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function SetComputerNameA(lpComputerName:LPCSTR):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function SetComputerNameW(lpComputerName:LPCWSTR):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function GetComputerNameEx(NameType:COMPUTER_NAME_FORMAT; lpBuffer:LPSTR; var nSize:DWORD):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function GetComputerNameExA(NameType:COMPUTER_NAME_FORMAT; lpBuffer:LPSTR; var nSize:DWORD):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function GetComputerNameExW(NameType:COMPUTER_NAME_FORMAT; lpBuffer:LPWSTR; var nSize:DWORD):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function SetComputerNameEx(NameType:COMPUTER_NAME_FORMAT; lpBuffer:LPCSTR):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function SetComputerNameExA(NameType:COMPUTER_NAME_FORMAT; lpBuffer:LPCSTR):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function SetComputerNameExW(NameType:COMPUTER_NAME_FORMAT; lpBuffer:LPCWSTR):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function ExitUltibo(dwReserved:DWORD; uReserved:UINT):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function ExitUltiboEx(uFlags:UINT; dwReserved:DWORD):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
General functions (Ultibo)
function RestartComputer(Delay:LongWord):Boolean;
Description: To be documented
| Delay | Milliseconds to delay before restart | 
|---|
function ShutdownComputer(Delay:LongWord):Boolean;
Description: To be documented
| Delay | Milliseconds to delay before restart | 
|---|
function Uptime:TFileTime;
Description: Get the current system up time as a FileTime value
| Note | To be documented | 
|---|
Time functions (Compatibility)
function GetTickCount:DWORD;
Description: To be documented
| Note | To be documented | 
|---|
function GetTickCount64:ULONGLONG;
Description: To be documented
| Note | To be documented | 
|---|
procedure GetSystemTime(var lpSystemTime:SYSTEMTIME);
Description: Get the current system time in UTC
| Note | To be documented | 
|---|
procedure GetSystemTimeAsFileTime(var lpSystemTimeAsFileTime:FILETIME);
Description: Get the current system time in UTC as a FileTime value
| Note | To be documented | 
|---|
function SetSystemTime(var lpSystemTime:SYSTEMTIME):BOOL;
Description: Set the current system time in UTC
| Note | To be documented | 
|---|
procedure GetLocalTime(var lpSystemTime:SYSTEMTIME);
Description: Get the current local time
| Note | To be documented | 
|---|
function SetLocalTime(var lpSystemTime:SYSTEMTIME):BOOL;
Description: Set the current local time
| Note | To be documented | 
|---|
function SystemTimeToTzSpecificLocalTime(lpTimeZoneInformation:LPTIME_ZONE_INFORMATION; var lpUniversalTime,lpLocalTime:SYSTEMTIME):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function TzSpecificLocalTimeToSystemTime(const lpTimeZoneInformation:TIME_ZONE_INFORMATION; const lpLocalTime:SYSTEMTIME; var lpUniversalTime:SYSTEMTIME):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function GetTimeZoneInformation(var lpTimeZoneInformation:TIME_ZONE_INFORMATION):DWORD;
Description: To be documented
| Note | To be documented | 
|---|
function SetTimeZoneInformation(const lpTimeZoneInformation:TIME_ZONE_INFORMATION):BOOL;
Description: To be documented
| Note | To be documented | 
|---|
function SystemTimeToFileTime(const lpSystemTime:SYSTEMTIME; var lpFileTime:FILETIME):BOOL;
Description: Convert a SystemTime value to a FileTime value
| Note | lpSystemTime is assumed to be UTC / lpFileTime is returned as UTC | 
|---|
function FileTimeToSystemTime(const lpFileTime:FILETIME; var lpSystemTime:SYSTEMTIME):BOOL;
Description: Convert a FileTime value to a SystemTime value
| Note | lpFileTime is assumed to be UTC / lpSystemTime is returned as UTC. If lpFileTime is less than 30/12/1899 then SystemTime will be zero. | 
|---|
function FileTimeToLocalFileTime(const lpFileTime:FILETIME; var lpLocalFileTime:FILETIME):BOOL;
Description: Convert a FileTime in UTC to a FileTime in Local time
| Note | TIMEZONE_TIME_OFFSET is the number of minutes offset from UTC | 
|---|
function LocalFileTimeToFileTime(const lpLocalFileTime:FILETIME; var lpFileTime:FILETIME):BOOL;
Description: Convert a FileTime in Local time to a FileTime in UTC
| Note | TIMEZONE_TIME_OFFSET is the number of minutes offset from UTC | 
|---|
function CompareFileTime(const lpFileTime1,lpFileTime2:FILETIME):LONG;
Description: To be documented
| Note | To be documented | 
|---|
function FileTimeToDosDateTime(const lpFileTime:FILETIME; var lpFatDate,lpFatTime:WORD):BOOL;
Description: Convert a FileTime value to a DOS date and time value
| Note | FileTime is assumed to be Local / DOS data and time is returned as Local. If FileTime is less than 1/1/1980 then DOS date and time will be zero. | 
|---|
function DosDateTimeToFileTime(wFatDate,wFatTime:WORD; var lpFileTime:FILETIME):BOOL;
Description: Convert a DOS date and time value to a FileTime value
| Note | DOS date and time is assumed to be Local / FileTime is returned as Local. If DOS date and time is less than 1/1/1980 then FileTime will be zero. | 
|---|
Return to Unit Reference