Difference between revisions of "Unit Ultibo"

From Ultibo.org
Jump to: navigation, search
Line 1,989: Line 1,989:
 
! '''Note'''
 
! '''Note'''
 
| To be documented
 
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
 +
'''Directory 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 CreateDirectory(lpPathName:LPCSTR; lpSecurityAttributes:LPSECURITY_ATTRIBUTES):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 CreateDirectoryA(lpPathName:LPCSTR; lpSecurityAttributes:LPSECURITY_ATTRIBUTES):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'''
 +
| lpSecurityAttributes is currently ignored by Ultibo
 +
|-
 +
|}
 +
</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 CreateDirectoryW(lpPathName:LPCWSTR; lpSecurityAttributes:LPSECURITY_ATTRIBUTES):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'''
 +
| lpSecurityAttributes is currently ignored by Ultibo
 +
|-
 +
|}
 +
</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 RemoveDirectory(lpPathName:LPCSTR):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 RemoveDirectoryA(lpPathName:LPCSTR):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 RemoveDirectoryW(lpPathName:LPCWSTR):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 SetCurrentDirectory(lpPathName:LPCSTR):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 SetCurrentDirectoryA(lpPathName:LPCSTR):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 SetCurrentDirectoryW(lpPathName:LPCWSTR):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 GetCurrentDirectory(nBufferLength:DWORD; lpBuffer:LPSTR):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 GetCurrentDirectoryA(nBufferLength:DWORD; lpBuffer:LPSTR):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 GetCurrentDirectoryW(nBufferLength:DWORD; lpBuffer:LPWSTR):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 GetLongPathName(lpszShortPath:LPCSTR; lpszLongPath:LPSTR; cchBuffer:DWORD):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 GetLongPathNameA(lpszShortPath:LPCSTR; lpszLongPath:LPSTR; cchBuffer:DWORD):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 GetLongPathNameW(lpszShortPath:LPCWSTR; lpszLongPath:LPWSTR; cchBuffer:DWORD):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 GetShortPathName(lpszLongPath:LPCSTR; lpszShortPath:LPSTR; cchBuffer:DWORD):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 GetShortPathNameA(lpszLongPath:LPCSTR; lpszShortPath:LPSTR; cchBuffer:DWORD):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 GetShortPathNameW(lpszLongPath:LPCWSTR; lpszShortPath:LPWSTR; cchBuffer:DWORD):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 GetFullPathName(lpFileName:LPCSTR; nBufferLength:DWORD; lpBuffer:LPSTR; var lpFilePart:LPSTR):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 GetFullPathNameA(lpFileName:LPCSTR; nBufferLength:DWORD; lpBuffer:LPSTR; var lpFilePart:LPSTR):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'''
 +
| lpFilePart is currently ignored by Ultibo
 +
|-
 +
|}
 +
</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 GetFullPathNameW(lpFileName:LPCWSTR; nBufferLength:DWORD; lpBuffer:LPWSTR; var lpFilePart:LPWSTR):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'''
 +
| lpFilePart is currently ignored by Ultibo
 
|-
 
|-
 
|}
 
|}

Revision as of 07:25, 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.


Time functions (Ultibo)

function GetCurrentTime:TFileTime;
Description: Get the current system time in UTC as a FileTime value
Note To be documented


procedure SetCurrentTime(const ATime:TFileTime);
Description: Set the current system time in UTC from a FileTime value
Note To be documented


function GetTimeAdjust:LongInt;
Description: Gets the time adjustment used internally
Note To be documented


procedure SetTimeAdjust(AAdjust:LongInt);
Description: Sets the time adjustment used internally
Note To be documented


function GetCurrentTimezone:String;
Description: Get the name of the current Timezone
Note To be documented


function SetCurrentTimezone(const AName:String):Boolean;
Description: Set the current Timezone by name
Note To be documented


function GetTimezoneActiveOffset:LongInt;
Description: Gets the Active Offset from the current Timezone
Note To be documented


function GetTimezoneStandardOffset:LongInt;
Description: Gets the Standard Offset from the current Timezone
Note To be documented


procedure SetTimezoneStandardOffset(AOffset:LongInt);
Description: Sets the Standard Offset for the current Timezone
Note To be documented


function GetTimezoneDaylightOffset:LongInt;
Description: Gets the Daylight Offset from the current Timezone
Note To be documented


procedure SetTimezoneDaylightOffset(AOffset:LongInt);
Description: Sets the Daylight Offset for the current Timezone
Note To be documented


function GetTimezoneStandardStart:String;
Description: Get the description of the standard time start for the current Timezone
Note To be documented


function GetTimezoneDaylightStart:String;
Description: Get the description of the daylight time start for the current Timezone
Note To be documented


function GetTimezoneStandardDate:TDateTime;
Description: Get the next date of the standard time start for the current Timezone
Note To be documented


function GetTimezoneDaylightDate:TDateTime;
Description: Get the next date of the daylight time start for the current Timezone
Note To be documented


function FileTimeToDateTime(const AFileTime:TFileTime):TDateTime;
Description: Convert a FileTime value to a DateTime value
Note FileTime is assumed to be UTC / DateTime is returned as Local. If FileTime is less than 30/12/1899 then Result will be zero.


function DateTimeToFileTime(ADateTime:TDateTime):TFileTime;
Description: Convert a DateTime value to a FileTime value
Note DateTime is assumed to be Local / FileTime is returned as UTC


function LocalFileTimeToDateTime(const AFileTime:TFileTime):TDateTime;
Description: Convert a FileTime value to a DateTime value
Note FileTime is assumed to be Local / DateTime is returned as Local. If FileTime is less than 30/12/1899 then Result will be zero.


function DateTimeToLocalFileTime(ADateTime:TDateTime):TFileTime;
Description: Convert a DateTime value to a FileTime value
Note DateTime is assumed to be Local / FileTime is returned as Local


function SystemFileTimeToDateTime(const AFileTime:TFileTime):TDateTime;
Description: Convert a FileTime value to a DateTime value
Note FileTime is assumed to be UTC / DateTime is returned as UTC. If FileTime is less than 30/12/1899 then Result will be zero. Same as LocalFileTimeToDateTime but renamed for clarity.


function DateTimeToSystemFileTime(ADateTime:TDateTime):TFileTime;
Description: Convert a DateTime value to a FileTime value
Note DateTime is assumed to be UTC / FileTime is returned as UTC. Same as DateTimeToLocalFileTime but renamed for clarity.


function FileTimeToUnixTime(const AFileTime:TFileTime):LongInt;
Description: Convert a FileTime value to a Unix/Linux time value
Note FileTime is assumed to be Local / UnixTime is returned as Local. If FileTime is less than 1/1/1970 then Result will be zero.


function UnixTimeToFileTime(AUnixTime:LongInt):TFileTime;
Description: Convert a Unix/Linux time value to a FileTime value
Note UnixTime is assumed to be Local / FileTime is returned as Local


function UnixTimeToDateTime(AUnixTime:LongInt):TDateTime;
Description: Convert a Unix/Linux time value to a DateTime value
Note UnixTime is assumed to be Local / DateTime is returned as Local


function DateTimeToUnixTime(ADateTime:TDateTime):LongInt;
Description: Convert a DateTime value to a Unix/Linux time value
Note DateTime is assumed to be Local / UnixTime is returned as Local. If DateTime is less than 1/1/1970 then Result will be zero.


function FileTimeToFileDate(const AFileTime:TFileTime):Integer;
Description: Convert a FileTime value to a DOS date value
Note FileTime is assumed to be UTC / FileDate is returned as Local. If FileTime is less than 1/1/1980 then Result will be zero.


function FileDateToFileTime(AFileDate:Integer):TFileTime;
Description: Convert a DOS date value to a FileTime value
Note FileDate is assumed to be Local / FileTime is returned as UTC. If FileDate is less than 1/1/1980 then Result will be zero.


function FileTimeToAdjustedTime(const AFileTime:TFileTime):TFileTime;
Description: Convert a local FileTime value to a DST adjusted FileTime value
Note TIMEZONE_TIME_ADJUST is the number of minutes difference from TIMEZONE_TIME_OFFSET


function AdjustedTimeToFileTime(const AFileTime:TFileTime):TFileTime;
Description: Convert a DST adjusted FileTime value to a local FileTime value
Note TIMEZONE_TIME_ADJUST is the number of minutes difference from TIMEZONE_TIME_OFFSET


function RoundFileTime(const AFileTime:TFileTime):TFileTime;
Description: Round FileTime to nearest 2 seconds for compatibility with FileDate
Note To be documented


function ConvertFileTime(const AFileTime:TFileTime; AOffset:Integer; ALocal:Boolean):TFileTime;
Description: Convert a FileTime value to a specified offset (Local or UTC)
Note Offset is the number of minutes to adjust in conversion. Local indicates whether the source time is Local or UTC.


function ConvertDateTime(ADateTime:TDateTime; AOffset:Integer; ALocal:Boolean):TDateTime;
Description: Convert a DateTime value to a specified offset (Local or UTC)
Note Offset is the number of minutes to adjust in conversion. Local indicates whether the source time is Local or UTC.


Drive functions (Compatibility)

function GetDiskType(lpRootPathName:LPCSTR):UINT;
Description: To be documented
Note To be documented


function GetDriveTypeA(lpRootPathName:LPCSTR):UINT;
Description: To be documented
Note To be documented


function GetDriveTypeW(lpRootPathName:LPCWSTR):UINT;
Description: To be documented
Note To be documented


function GetLogicalDrives:DWORD;
Description: To be documented
Note To be documented


function GetLogicalDriveStrings(nBufferLength:DWORD; lpBuffer:LPSTR):DWORD;
Description: To be documented
Note To be documented


function GetLogicalDriveStringsA(nBufferLength:DWORD; lpBuffer:LPSTR):DWORD;
Description: To be documented
Note To be documented


function GetLogicalDriveStringsW(nBufferLength:DWORD; lpBuffer:LPWSTR):DWORD;
Description: To be documented
Note To be documented


function DefineDosDevice(dwFlags:DWORD; lpDeviceName,lpTargetPath:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function DefineDosDeviceA(dwFlags:DWORD; lpDeviceName,lpTargetPath:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function DefineDosDeviceW(dwFlags:DWORD; lpDeviceName,lpTargetPath:LPCWSTR):BOOL;
Description: To be documented
Note To be documented


function QueryDosDevice(lpDeviceName,lpTargetPath:LPSTR; ucchMax:DWORD):DWORD;
Description: To be documented
Note To be documented


function QueryDosDeviceA(lpDeviceName,lpTargetPath:LPSTR; ucchMax:DWORD):DWORD;
Description: To be documented
Note To be documented


function QueryDosDeviceW(lpDeviceName,lpTargetPath:LPWSTR; ucchMax:DWORD):DWORD;
Description: To be documented
Note To be documented


function SetVolumeLabel(lpRootPathName,lpVolumeName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function SetVolumeLabelA(lpRootPathName,lpVolumeName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function SetVolumeLabelW(lpRootPathName,lpVolumeName:LPCWSTR):BOOL;
Description: To be documented
Note To be documented


function GetVolumeInformation(lpRootPathName:LPCSTR; lpVolumeNameBuffer:LPSTR; nVolumeNameSize:DWORD; lpVolumeSerialNumber:LPDWORD; var lpMaximumComponentLength,lpFileSystemFlags:DWORD; lpFileSystemNameBuffer:LPSTR; nFileSystemNameSize:DWORD):BOOL;
Description: To be documented
Note To be documented


function GetVolumeInformationA(lpRootPathName:LPCSTR; lpVolumeNameBuffer:LPSTR; nVolumeNameSize:DWORD; lpVolumeSerialNumber:LPDWORD; var lpMaximumComponentLength,lpFileSystemFlags:DWORD;lpFileSystemNameBuffer:LPSTR; nFileSystemNameSize:DWORD):BOOL;
Description: To be documented
Note To be documented


function GetVolumeInformationW(lpRootPathName:LPCWSTR; lpVolumeNameBuffer:LPWSTR; nVolumeNameSize:DWORD; lpVolumeSerialNumber:LPDWORD; var lpMaximumComponentLength,lpFileSystemFlags:DWORD;lpFileSystemNameBuffer:LPWSTR; nFileSystemNameSize:DWORD):BOOL;
Description: To be documented
Note To be documented


function GetDiskFreeSpace(lpRootPathName:LPCSTR; var lpSectorsPerCluster,lpBytesPerSector,lpNumberOfFreeClusters,lpTotalNumberOfClusters:DWORD):BOOL;
Description: To be documented
Note To be documented


function GetDiskFreeSpaceA(lpRootPathName:LPCSTR; var lpSectorsPerCluster,lpBytesPerSector,lpNumberOfFreeClusters,lpTotalNumberOfClusters:DWORD):BOOL;
Description: To be documented
Note To be documented


function GetDiskFreeSpaceW(lpRootPathName:LPCWSTR; var lpSectorsPerCluster,lpBytesPerSector,lpNumberOfFreeClusters,lpTotalNumberOfClusters:DWORD):BOOL;
Description: To be documented
Note To be documented


function GetDiskFreeSpaceEx(lpDirectoryName:LPCSTR; var lpFreeBytesAvailableToCaller,lpTotalNumberOfBytes:ULARGE_INTEGER; lpTotalNumberOfFreeBytes:PULARGE_INTEGER):BOOL;
Description: To be documented
Note To be documented


Drive functions (Ultibo)

function GetPathDrive(const APath:String):Byte;
Description: To be documented
Note To be documented


function GetDriveType(ADrive:Byte):TDriveType;
Description: To be documented
Note To be documented


function GetDriveData(ADrive:Byte):TDriveData;
Description: To be documented
Note To be documented


function GetDriveAttr(ADrive:Byte):LongWord;
Description: To be documented
Note To be documented


function GetDriveLabel(ADrive:Byte):String;
Description: To be documented
Note To be documented


function SetDriveLabel(ADrive:Byte; const ALabel:String):Boolean;
Description: To be documented
Note To be documented


function GetDriveSerial(ADrive:Byte):LongWord;
Description: To be documented
Note To be documented


function SetDriveSerial(ADrive:Byte; ASerial:LongWord):Boolean;
Description: To be documented
Note To be documented


function IsDriveValid(ADrive:Byte):Boolean;
Description: To be documented
Note To be documented


function GetValidDrives:LongWord;
Description: To be documented
Note To be documented


function GetValidDriveNames:String;
Description: To be documented
Note To be documented


function GetDriveFreeSpace(ADrive:Byte):LongWord;
Description: To be documented
Note To be documented


function GetDriveFreeSpaceEx(ADrive:Byte):Int64;
Description: To be documented
Note To be documented


function GetDriveTotalSpace(ADrive:Byte):LongWord;
Description: To be documented
Note To be documented


function GetDriveTotalSpaceEx(ADrive:Byte):Int64;
Description: To be documented
Note To be documented


function GetCurrentDrive:Byte;
Description: To be documented
Note To be documented


function SetCurrentDrive(const ADrive:String):Boolean;
Description: To be documented
Note To be documented


File functions (Compatibility)

function AreFileApisANSI:BOOL;
Description: To be documented
Note To be documented


procedure SetFileApisToOEM;
Description: To be documented
Note To be documented


procedure SetFileApisToANSI;
Description: To be documented
Note To be documented


function CreateFile(lpFileName:LPCSTR; dwDesiredAccess,dwShareMode:DWORD; lpSecurityAttributes:LPSECURITY_ATTRIBUTES; dwCreationDisposition:DWORD; dwFlagsAndAttributes:DWORD; hTemplateFile:HANDLE):HANDLE;
Description: To be documented
Note To be documented


function CreateFileA(lpFileName:LPCSTR; dwDesiredAccess,dwShareMode:DWORD; lpSecurityAttributes:LPSECURITY_ATTRIBUTES; dwCreationDisposition:DWORD; dwFlagsAndAttributes:DWORD; hTemplateFile:HANDLE):HANDLE;
Description: To be documented
Note lpSecurityAttributes and hTemplateFile are currently ignored by Ultibo


function CreateFileW(lpFileName:LPCWSTR; dwDesiredAccess,dwShareMode:DWORD; lpSecurityAttributes:LPSECURITY_ATTRIBUTES; dwCreationDisposition:DWORD; dwFlagsAndAttributes:DWORD; hTemplateFile:HANDLE):HANDLE;
Description: To be documented
Note lpSecurityAttributes and hTemplateFile are currently ignored by Ultibo


function SetFileAttributes(lpFileName:LPCSTR; dwFileAttributes:DWORD):BOOL;
Description: To be documented
Note To be documented


function SetFileAttributesA(lpFileName:LPCSTR; dwFileAttributes:DWORD):BOOL;
Description: To be documented
Note To be documented


function SetFileAttributesW(lpFileName:LPCWSTR; dwFileAttributes:DWORD):BOOL;
Description: To be documented
Note To be documented


function GetFileAttributes(lpFileName:LPCSTR):DWORD;
Description: To be documented
Note To be documented


function GetFileAttributesA(lpFileName:LPCSTR):DWORD;
Description: To be documented
Note To be documented


function GetFileAttributesW(lpFileName:LPCWSTR):DWORD;
Description: To be documented
Note To be documented


function DeleteFile(lpFileName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function DeleteFileA(lpFileName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function DeleteFileW(lpFileName:LPCWSTR):BOOL;
Description: To be documented
Note To be documented


function MoveFile(lpExistingFileName,lpNewFileName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function MoveFileA(lpExistingFileName,lpNewFileName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function MoveFileW(lpExistingFileName,lpNewFileName:LPCWSTR):BOOL;
Description: To be documented
Note To be documented


function FindFirstFile(lpFileName:LPCSTR; var lpFindFileData:WIN32_FIND_DATAA):HANDLE;
Description: To be documented
Note To be documented


function FindFirstFileA(lpFileName:LPCSTR; var lpFindFileData:WIN32_FIND_DATAA):HANDLE;
Description: To be documented
Note To be documented


function FindFirstFileW(lpFileName:LPCWSTR; var lpFindFileData:WIN32_FIND_DATAW):HANDLE;
Description: To be documented
Note To be documented


function FindNextFile(hFindFile:HANDLE; var lpFindFileData:WIN32_FIND_DATAA):BOOL;
Description: To be documented
Note To be documented


function FindNextFileA(hFindFile:HANDLE; var lpFindFileData:WIN32_FIND_DATAA):BOOL;
Description: To be documented
Note To be documented


function FindNextFileW(hFindFile:HANDLE; var lpFindFileData:WIN32_FIND_DATAW):BOOL;
Description: To be documented
Note To be documented


function FindCloseFile(hFindFile:HANDLE):BOOL;
Description: To be documented
Note To be documented


function GetFileSize(hFile:HANDLE;lpFileSizeHigh:LPDWORD):DWORD;
Description: To be documented
Note To be documented


function GetFileSizeEx(hFile:HANDLE; var lpFileSize:LARGE_INTEGER):BOOL;
Description: To be documented
Note To be documented


function GetFileTime(hFile:HANDLE; lpCreationTime,lpLastAccessTime,lpLastWriteTime:PFILETIME):BOOL;
Description: To be documented
Note To be documented


function SetFileTime(hFile:HANDLE; lpCreationTime,lpLastAccessTime,lpLastWriteTime:PFILETIME):BOOL;
Description: To be documented
Note To be documented


function ReadFile(hFile:HANDLE; lpBuffer:LPVOID; nNumberOfBytesToRead:DWORD; lpNumberOfBytesRead:LPDWORD; lpOverlapped:LPOVERLAPPED):BOOL;
Description: To be documented
Note To be documented


function WriteFile(hFile:HANDLE; lpBuffer:LPCVOID; nNumberOfBytesToWrite:DWORD; lpNumberOfBytesWritten:LPDWORD; lpOverlapped:LPOVERLAPPED):BOOL;
Description: To be documented
Note To be documented


function SetEndOfFile(hFile:HANDLE):BOOL;
Description: To be documented
Note To be documented


function SetFilePointer(hFile:HANDLE; lDistanceToMove:LONG; lpDistanceToMoveHigh:PLONG; dwMoveMethod:DWORD):DWORD;
Description: To be documented
Note To be documented


function SetFilePointerEx(hFile:HANDLE; liDistanceToMove:LARGE_INTEGER; lpNewFilePointer:PLARGE_INTEGER; dwMoveMethod:DWORD):BOOL;
Description: To be documented
Note To be documented


function FlushFileBuffers(hFile:HANDLE):BOOL;
Description: To be documented
Note To be documented


function CopyFile(lpExistingFileName,lpNewFileName:LPCSTR; bFailIfExists:BOOL):BOOL;
Description: To be documented
Note To be documented


function CopyFileA(lpExistingFileName,lpNewFileName:LPCSTR; bFailIfExists:BOOL):BOOL;
Description: To be documented
Note To be documented


function CopyFileW(lpExistingFileName,lpNewFileName:LPCWSTR; bFailIfExists:BOOL):BOOL;
Description: To be documented
Note To be documented


function SetFileShortName(hFile:HANDLE; lpShortName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function SetFileShortNameA(hFile:HANDLE; lpShortName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function SetFileShortNameW(hFile:HANDLE; lpShortName:LPCWSTR):BOOL;
Description: To be documented
Note To be documented


function CreateHardLink(lpFileName,lpExistingFileName:LPCSTR; lpSecurityAttributes:LPSECURITY_ATTRIBUTES):BOOL;
Description: To be documented
Note To be documented


function CreateHardLinkA(lpFileName,lpExistingFileName:LPCSTR; lpSecurityAttributes:LPSECURITY_ATTRIBUTES):BOOL;
Description: To be documented
Note lpSecurityAttributes is currently ignored by Ultibo


function CreateHardLinkW(lpFileName,lpExistingFileName:LPCWSTR; lpSecurityAttributes:LPSECURITY_ATTRIBUTES):BOOL;
Description: To be documented
Note lpSecurityAttributes is currently ignored by Ultibo


function CreateSymbolicLink(lpSymlinkFileName,lpTargetFileName:LPCSTR; dwFlags:DWORD):BOOL;
Description: To be documented
Note To be documented


function CreateSymbolicLinkA(lpSymlinkFileName,lpTargetFileName:LPCSTR; dwFlags:DWORD):BOOL;
Description: To be documented
Note To be documented


function CreateSymbolicLinkW(lpSymlinkFileName,lpTargetFileName:LPCWSTR; dwFlags:DWORD):BOOL;
Description: To be documented
Note To be documented


Directory functions (Compatibility)

function CreateDirectory(lpPathName:LPCSTR; lpSecurityAttributes:LPSECURITY_ATTRIBUTES):BOOL;
Description: To be documented
Note To be documented


function CreateDirectoryA(lpPathName:LPCSTR; lpSecurityAttributes:LPSECURITY_ATTRIBUTES):BOOL;
Description: To be documented
Note lpSecurityAttributes is currently ignored by Ultibo


function CreateDirectoryW(lpPathName:LPCWSTR; lpSecurityAttributes:LPSECURITY_ATTRIBUTES):BOOL;
Description: To be documented
Note lpSecurityAttributes is currently ignored by Ultibo


function RemoveDirectory(lpPathName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function RemoveDirectoryA(lpPathName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function RemoveDirectoryW(lpPathName:LPCWSTR):BOOL;
Description: To be documented
Note To be documented


function SetCurrentDirectory(lpPathName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function SetCurrentDirectoryA(lpPathName:LPCSTR):BOOL;
Description: To be documented
Note To be documented


function SetCurrentDirectoryW(lpPathName:LPCWSTR):BOOL;
Description: To be documented
Note To be documented


function GetCurrentDirectory(nBufferLength:DWORD; lpBuffer:LPSTR):DWORD;
Description: To be documented
Note To be documented


function GetCurrentDirectoryA(nBufferLength:DWORD; lpBuffer:LPSTR):DWORD;
Description: To be documented
Note To be documented


function GetCurrentDirectoryW(nBufferLength:DWORD; lpBuffer:LPWSTR):DWORD;
Description: To be documented
Note To be documented


function GetLongPathName(lpszShortPath:LPCSTR; lpszLongPath:LPSTR; cchBuffer:DWORD):DWORD;
Description: To be documented
Note To be documented


function GetLongPathNameA(lpszShortPath:LPCSTR; lpszLongPath:LPSTR; cchBuffer:DWORD):DWORD;
Description: To be documented
Note To be documented


function GetLongPathNameW(lpszShortPath:LPCWSTR; lpszLongPath:LPWSTR; cchBuffer:DWORD):DWORD;
Description: To be documented
Note To be documented


function GetShortPathName(lpszLongPath:LPCSTR; lpszShortPath:LPSTR; cchBuffer:DWORD):DWORD;
Description: To be documented
Note To be documented


function GetShortPathNameA(lpszLongPath:LPCSTR; lpszShortPath:LPSTR; cchBuffer:DWORD):DWORD;
Description: To be documented
Note To be documented


function GetShortPathNameW(lpszLongPath:LPCWSTR; lpszShortPath:LPWSTR; cchBuffer:DWORD):DWORD;
Description: To be documented
Note To be documented


function GetFullPathName(lpFileName:LPCSTR; nBufferLength:DWORD; lpBuffer:LPSTR; var lpFilePart:LPSTR):DWORD;
Description: To be documented
Note To be documented


function GetFullPathNameA(lpFileName:LPCSTR; nBufferLength:DWORD; lpBuffer:LPSTR; var lpFilePart:LPSTR):DWORD;
Description: To be documented
Note lpFilePart is currently ignored by Ultibo


function GetFullPathNameW(lpFileName:LPCWSTR; nBufferLength:DWORD; lpBuffer:LPWSTR; var lpFilePart:LPWSTR):DWORD;
Description: To be documented
Note lpFilePart is currently ignored by Ultibo


Return to Unit Reference