Unit Timezone

Return to Unit Reference

Description

---

Ultibo Timezone interface unit

To be documented

Constants

---

[Expand]

Timezone specific constants TIME_ZONE_*

TIME_ZONE_ID_UNKNOWN = 0;
TIME_ZONE_ID_STANDARD = 1;
TIME_ZONE_ID_DAYLIGHT = 2;
TIME_ZONE_ID_INVALID = DWORD($FFFFFFFF);

[Expand]

Timezone signature TIMEZONE_SIGNATURE_*

TIMEZONE_SIGNATURE = $ED9A1BC3;

Type definitions

---

System time

[Expand]

LPSYSTEMTIME = ^SYSTEMTIME;

SYSTEMTIME = _SYSTEMTIME;

TSystemTime = SYSTEMTIME;

PSystemTime = LPSYSTEMTIME;

_SYSTEMTIME = record

wYear:Word;
wMonth:Word;
wDayOfWeek:Word;
wDay:Word;
wHour:Word;
wMinute:Word;
wSecond:Word;
wMilliseconds:Word;

Timezone information

[Expand]

TIME_ZONE_INFORMATION = _TIME_ZONE_INFORMATION;

LPTIME_ZONE_INFORMATION = ^TIME_ZONE_INFORMATION;

TTimeZoneInformation = TIME_ZONE_INFORMATION;

PTimeZoneInformation = PTIME_ZONE_INFORMATION;

PTIME_ZONE_INFORMATION = ^TIME_ZONE_INFORMATION;

_TIME_ZONE_INFORMATION = record

Bias:LONG;
StandardName:array [0..31] of WCHAR;
StandardDate:SYSTEMTIME;
StandardBias:LONG;
DaylightName:array [0..31] of WCHAR;
DaylightDate:SYSTEMTIME;
DaylightBias:LONG;

Timezone data

[Expand]

PTimezoneData = ^TTimezoneData;

TTimezoneData = record

Name:String[32];
Description:String[64];
Bias:LongInt;
StandardName:String[32];
StandardBias:LongInt;
StandardStart:TSystemTime;
DaylightName:String[32];
DaylightBias:LongInt;
DaylightStart:TSystemTime;

Timezone enumeration callback

TTimezoneEnumerate = function(Timezone:PTimezoneEntry; Data:Pointer):LongWord;

Timezone entry

[Expand]

PTimezoneEntry = ^TTimezoneEntry;

TTimezoneEntry = record

Timezone Properties
Signature:LongWord;	Signature for entry validation
Name:String;
Description:String;
Bias:LongInt;
StandardName:String;
StandardBias:LongInt;
StandardStart:TSystemTime;
DaylightName:String;
DaylightBias:LongInt;
DaylightStart:TSystemTime;
Internal Properties
Prev:PTimezoneEntry;	Previous entry in Timezone table
Next:PTimezoneEntry;	Next entry in Timezone table

Public variables

---

None defined

Function declarations

---

Initialization functions

[Expand]

procedure TimezoneInit;

Description: To be documented

Note	None documented

Timezone functions

[Expand]

function TimezoneAdd(Data:PTimezoneData; Default:Boolean):LongWord;

Description: Add a Timezone from a timezone data block and to the Timezone table

Note	None documented

[Expand]

function TimezoneDelete(Timezone:PTimezoneEntry):LongWord;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetName(Timezone:PTimezoneEntry):String;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetDescription(Timezone:PTimezoneEntry):String;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetBias(Timezone:PTimezoneEntry):LongInt;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetState(Timezone:PTimezoneEntry):LongWord;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetActiveBias(Timezone:PTimezoneEntry):LongInt;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetStandardName(Timezone:PTimezoneEntry):String;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetStandardBias(Timezone:PTimezoneEntry):LongInt;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetStandardDate(Timezone:PTimezoneEntry; Next:Boolean):TDateTime;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetStandardStart(Timezone:PTimezoneEntry):SYSTEMTIME;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetDaylightName(Timezone:PTimezoneEntry):String;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetDaylightBias(Timezone:PTimezoneEntry):LongInt;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetDaylightDate(Timezone:PTimezoneEntry; Next:Boolean):TDateTime;

Description: To be documented

Note	None documented

[Expand]

function TimezoneGetDaylightStart(Timezone:PTimezoneEntry):SYSTEMTIME;

Description: To be documented

Note	None documented

[Expand]

function TimezoneFind(const Name:String):PTimezoneEntry;

Description: To be documented

Note	None documented

[Expand]

function TimezoneEnumerate(Callback:TTimezoneEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	None documented

Timezone helper functions

[Expand]

function TimezoneGetCount:LongWord; inline;

Description: Get the current timezone count

Note	None documented

[Expand]

function TimezoneGetDefault:PTimezoneEntry; inline;

Description: Get the current default timezone

Note	None documented

[Expand]

function TimezoneSetDefault(Timezone:PTimezoneEntry):LongWord;

Description: Set the current default timezone

Note	None documented

[Expand]

function TimezoneCheck(Timezone:PTimezoneEntry):PTimezoneEntry;

Description: Check if the supplied Timezone is in the Timezone table

Note	None documented

[Expand]

function TimezoneUpdateOffset:LongWord;

Description: To be documented

Note	None documented

[Expand]

function TimezoneStartToDateTime(const AStart:SYSTEMTIME; AYear:Word):TDateTime;

Description: Calculate the start date and time from the start date of a timezone

Note	None documented

[Expand]

function TimezoneStartToDescription(const AStart:SYSTEMTIME):String;

Description: Get the description of the start date of a timezone

Note	None documented

[Expand]

function TimezoneNameReplaceChar(const AName:String; AChar,AReplace:Char):String;

Description: Same as ReplaceChar in UltiboUtils, reproduced here to avoid including extra units

Note	None documented

Return to Unit Reference