diff --git a/PasDocSettings.pds b/PasDocSettings.pds index a2ae71b..2e6f28d 100644 --- a/PasDocSettings.pds +++ b/PasDocSettings.pds @@ -4,7 +4,7 @@ Language=en OutputDir=docs GenerateFormat=0 ProjectName= -Verbosity=2 +Verbosity=3 ClassMembers_0=1 ClassMembers_1=1 ClassMembers_2=1 @@ -12,7 +12,7 @@ ClassMembers_3=0 ClassMembers_4=0 ClassMembers_5=0 ClassMembers_6=1 -ClassMembers_7=0 +ClassMembers_7=1 ImplicitVisibility=0 Sorting_0=1 Sorting_1=1 @@ -28,7 +28,7 @@ CssFileName= IntroductionFileName= ConclusionFileName= WriteUsesList=1 -AutoAbstract=0 +AutoAbstract=1 AutoLink=1 HandleMacros=0 UseTipueSearch=1 @@ -40,12 +40,13 @@ VizGraphUses=0 CheckSpelling=1 LatexGraphicsPackage=0 [Defines] -Count=5 -Item_0=UNICODE -Item_1=MSWINDOWS -Item_2=WIN32 -Item_3=CPU386 -Item_4=CONDITIONALEXPRESSIONS +Count=6 +Item_0=PASDOC +Item_1=UNICODE +Item_2=MSWINDOWS +Item_3=WIN32 +Item_4=CPU386 +Item_5=CONDITIONALEXPRESSIONS [Header] Count=1 Item_0=TZDB for Delphi Documentation by pasdoc 2018-03-04 @@ -53,11 +54,13 @@ Item_0=TZDB for Delphi Documentation by pasdoc 2018-03-04 Count=1 Item_0=prepared by M.Taylor [IncludeDirectories] -Count=1 +Count=2 Item_0=src\TZDBPK +Item_1=src\TZDBLIB [Files] -Count=1 -Item_0=src\TZDBPK\TZDB.pas +Count=2 +Item_0=src\TZDBLIB\TZCAPI.pas +Item_1=src\TZDBPK\TZDB.pas [HyphenatedWords] Count=0 [SpecialMarkers] diff --git a/docs/AllClasses.html b/docs/AllClasses.html index e60462f..1e03eb7 100644 --- a/docs/AllClasses.html +++ b/docs/AllClasses.html @@ -4,7 +4,7 @@ Delphi TZDB: All Classes, Interfaces, Objects and Records - + @@ -26,7 +26,8 @@

Delphi TZDB

Units

< }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

All Classes, Interfaces, Objects and Records

+TZDB for Delphi Documentation by pasdoc 2018-03-04 +

All Classes, Interfaces, Objects and Records

@@ -34,16 +35,27 @@

Delphi TZDB

Units

< - + - + + + + + + - + + + + + +
NameDescription
ETimeZoneInvalidELocalTimeInvalid TZDB

Exception type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.

<summary>Exception thrown when the passed local time is invalid.</summary>
ETimeZoneInvalidTZDB

<summary>Exception type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.</summary>

TBundledTimeZone TZDB

A timezone class implementation that retreives its data from the bundled database.

<summary>A timezone class implementation that retreives its data from the bundled database.</summary> <remarks>This class inherits the standard <c>TTimeZone</c> class in Delphi XE.</remarks>

TZ_InstanceTZCAPI

<summary>An opaque structure that identifies a time zone object.</summary>
-prepared by M.Taylor
Generated by PasDoc 0.15.0. +prepared by M.Taylor +
Generated by PasDoc 0.15.0. diff --git a/docs/AllConstants.html b/docs/AllConstants.html index 9f3c021..2900e2f 100644 --- a/docs/AllConstants.html +++ b/docs/AllConstants.html @@ -4,7 +4,7 @@ Delphi TZDB: All Constants - + @@ -26,9 +26,56 @@

Delphi TZDB

Units

< }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

All Constants

-

-The units do not contain any constants.

-prepared by M.Taylor
Generated by PasDoc 0.15.0. +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

All Constants

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameUnitDescription
ERROR_INST_DISPOSEDTZCAPI

<summary>The time zone instance passed to the function was detected as being disposed.</summary>

ERROR_INVALID_ARGTZCAPI

<summary>An argument passed to the function was invalid.</summary>

ERROR_INVALID_LOCAL_TIMETZCAPI

<summary>The local time value passed to the function was invalid in the given time zone.</summary>

ERROR_UNKNOWNTZCAPI

<summary>A generic error.

LOCAL_TIME_AMBIGUOUSTZCAPI

<summary>The local time is in DST -> Standard year period.</summary>

LOCAL_TIME_DAYLIGHTTZCAPI

<summary>The local time is in the DST year period.</summary>

LOCAL_TIME_INVALIDTZCAPI

<summary>The local time is in the Standard -> DST year period.</summary>

LOCAL_TIME_STANDARDTZCAPI

<summary>The local time is in the Standard year period.</summary>

+prepared by M.Taylor +
Generated by PasDoc 0.15.0. diff --git a/docs/AllFunctions.html b/docs/AllFunctions.html index 7cbfa4f..5ea0bb6 100644 --- a/docs/AllFunctions.html +++ b/docs/AllFunctions.html @@ -4,7 +4,7 @@ Delphi TZDB: All Functions and Procedures - + @@ -26,9 +26,61 @@

Delphi TZDB

Units

< }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

All Functions and Procedures

-

-The units do not contain any functions or procedures.

-prepared by M.Taylor
Generated by PasDoc 0.15.0. +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

All Functions and Procedures

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameUnitDescription
TZ_EnumTimeZonesTZCAPI

<summary>Lists all known/supported time zone names.</summary> <param name="Data">User provided data that is passed along to <paramref name="EnumProc"/>.</param> <param name="IncludeAliases">Pass <c>True</c> to include time zone aliases into the list.</param> <param name="EnumProc">The enumerator procedure called for each item in the list.</param> <returns><c>True</c> is returned if the enumeration process was interrupted by the consumer.

TZ_GetAbbreviationTZCAPI

<summary>Generates an abbreviation string for the given local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time (C format).</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="Abbrev">The output string parameter.

TZ_GetDisplayNameTZCAPI

<summary>Generates a diplay name for the given local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time (C format).</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="DispName">The output string parameter.

TZ_GetLocalTimeTypeTZCAPI

<summary>Returns the type of the local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time.</param> <returns>A zero or a positive result means success.

TZ_GetUtcOffsetTZCAPI

<summary>Returns the UTC offset of the given local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time.</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="TimeType">An output parameter to which the UTC offset if copied.</param> <returns>A zero or a positive value means success.

TZ_InitInstanceTZCAPI

<summary>Looks up a time zone object by the given <paramref name="Name"/>.</summary> <param name="Name">The name time zone name to lookup.

TZ_LocalToUtcTZCAPI

<summary>Converts a local time to UTC time.</summary> <param name="Instance">The time zone instance.</param> <param name="LocalTime">The local time to be converted.</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="UtcTime">The output parameter to hold the converted UTC time.</param> <returns>A zero or a positive value means success.

TZ_ReleaseInstanceTZCAPI

<summary>Releases a previously acquired instance.</summary> <param name="Instance">The time zone instance.</param> <returns>A zero or a positive value means success.

TZ_UtcToLocalTZCAPI

<summary>Converts an UTC time to a local time.</summary> <param name="Instance">The time zone instance.</param> <param name="UtcTime">The UTC time to be converted.</param> <param name="LocalTime">The output parameter to hold the converted local time.</param> <returns>A zero or a positive value means success.

+prepared by M.Taylor +
Generated by PasDoc 0.15.0. diff --git a/docs/AllIdentifiers.html b/docs/AllIdentifiers.html index 80e01e6..a096587 100644 --- a/docs/AllIdentifiers.html +++ b/docs/AllIdentifiers.html @@ -4,7 +4,7 @@ Delphi TZDB: All Identifiers - + @@ -26,7 +26,8 @@

Delphi TZDB

Units

< }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

All Identifiers

+TZDB for Delphi Documentation by pasdoc 2018-03-04 +

All Identifiers

@@ -34,16 +35,142 @@

Delphi TZDB

Units

< + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
ELocalTimeInvalidTZDB

<summary>Exception thrown when the passed local time is invalid.</summary>

ERROR_INST_DISPOSEDTZCAPI

<summary>The time zone instance passed to the function was detected as being disposed.</summary>

ERROR_INVALID_ARGTZCAPI

<summary>An argument passed to the function was invalid.</summary>

ERROR_INVALID_LOCAL_TIMETZCAPI

<summary>The local time value passed to the function was invalid in the given time zone.</summary>

ERROR_UNKNOWNTZCAPI

<summary>A generic error.

ETimeZoneInvalid TZDB

Exception type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.

<summary>Exception type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.</summary>

LOCAL_TIME_AMBIGUOUSTZCAPI

<summary>The local time is in DST -> Standard year period.</summary>
LOCAL_TIME_DAYLIGHTTZCAPI

<summary>The local time is in the DST year period.</summary>

LOCAL_TIME_INVALIDTZCAPI

<summary>The local time is in the Standard -> DST year period.</summary>

LOCAL_TIME_STANDARDTZCAPI

<summary>The local time is in the Standard year period.</summary>

PTZ_InstanceTZCAPI

<summary>A <c>Pointer</c> to a <see cref="TZCAPI|TZ_Instance"/> stucture.</summary>

PTZ_TimeTZCAPI

<summary>A <c>Pointer</c> to a <see cref="TZCAPI|TZ_Time"/> type.</summary>

TBundledTimeZone TZDB

A timezone class implementation that retreives its data from the bundled database.

<summary>A timezone class implementation that retreives its data from the bundled database.</summary> <remarks>This class inherits the standard <c>TTimeZone</c> class in Delphi XE.</remarks>

TLocalTimeTypeTZDB

<summary>Defines four types that a local date/time type can be in.</summary>

TZ_EnumProcTZCAPI

<summary>Time zone enumerator procedure.</summary> <param name="Data">A data object provided by the consumer code.</param> <param name="Name">The name of the currently enumerated time zone.</param> <returns>Consmer must return <c>True</c> to interrupt the enumeraton process.</returns>

TZ_EnumTimeZonesTZCAPI

<summary>Lists all known/supported time zone names.</summary> <param name="Data">User provided data that is passed along to <paramref name="EnumProc"/>.</param> <param name="IncludeAliases">Pass <c>True</c> to include time zone aliases into the list.</param> <param name="EnumProc">The enumerator procedure called for each item in the list.</param> <returns><c>True</c> is returned if the enumeration process was interrupted by the consumer.

TZ_GetAbbreviationTZCAPI

<summary>Generates an abbreviation string for the given local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time (C format).</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="Abbrev">The output string parameter.

TZ_GetDisplayNameTZCAPI

<summary>Generates a diplay name for the given local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time (C format).</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="DispName">The output string parameter.

TZ_GetLocalTimeTypeTZCAPI

<summary>Returns the type of the local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time.</param> <returns>A zero or a positive result means success.

TZ_GetUtcOffsetTZCAPI

<summary>Returns the UTC offset of the given local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time.</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="TimeType">An output parameter to which the UTC offset if copied.</param> <returns>A zero or a positive value means success.

TZ_InitInstanceTZCAPI

<summary>Looks up a time zone object by the given <paramref name="Name"/>.</summary> <param name="Name">The name time zone name to lookup.

TZ_InstanceTZCAPI

<summary>An opaque structure that identifies a time zone object.</summary>

TZ_LocalToUtcTZCAPI

<summary>Converts a local time to UTC time.</summary> <param name="Instance">The time zone instance.</param> <param name="LocalTime">The local time to be converted.</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="UtcTime">The output parameter to hold the converted UTC time.</param> <returns>A zero or a positive value means success.

TZ_ReleaseInstanceTZCAPI

<summary>Releases a previously acquired instance.</summary> <param name="Instance">The time zone instance.</param> <returns>A zero or a positive value means success.

TZ_ResultTZCAPI

<summary>A somewhat generic type used for most API methods in this library.</summary> <remarks>All negative values of this type signify an error.

TZ_TimeTZCAPI

<summary>An <c>Int64</c> representing the C/UNIX time format.</summary>

TZ_UtcToLocalTZCAPI

<summary>Converts an UTC time to a local time.</summary> <param name="Instance">The time zone instance.</param> <param name="UtcTime">The UTC time to be converted.</param> <param name="LocalTime">The output parameter to hold the converted local time.</param> <returns>A zero or a positive value means success.
-prepared by M.Taylor
Generated by PasDoc 0.15.0. +prepared by M.Taylor +
Generated by PasDoc 0.15.0. diff --git a/docs/AllTypes.html b/docs/AllTypes.html index 82aa7be..472dca8 100644 --- a/docs/AllTypes.html +++ b/docs/AllTypes.html @@ -4,7 +4,7 @@ Delphi TZDB: All Types - + @@ -26,9 +26,46 @@

Delphi TZDB

Units

< }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

All Types

-

-The units do not contain any types.

-prepared by M.Taylor
Generated by PasDoc 0.15.0. +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

All Types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameUnitDescription
PTZ_InstanceTZCAPI

<summary>A <c>Pointer</c> to a <see cref="TZCAPI|TZ_Instance"/> stucture.</summary>

PTZ_TimeTZCAPI

<summary>A <c>Pointer</c> to a <see cref="TZCAPI|TZ_Time"/> type.</summary>

TLocalTimeTypeTZDB

<summary>Defines four types that a local date/time type can be in.</summary>

TZ_EnumProcTZCAPI

<summary>Time zone enumerator procedure.</summary> <param name="Data">A data object provided by the consumer code.</param> <param name="Name">The name of the currently enumerated time zone.</param> <returns>Consmer must return <c>True</c> to interrupt the enumeraton process.</returns>

TZ_ResultTZCAPI

<summary>A somewhat generic type used for most API methods in this library.</summary> <remarks>All negative values of this type signify an error.

TZ_TimeTZCAPI

<summary>An <c>Int64</c> representing the C/UNIX time format.</summary>

+prepared by M.Taylor +
Generated by PasDoc 0.15.0. diff --git a/docs/AllUnits.html b/docs/AllUnits.html index 0453daf..8d8c787 100644 --- a/docs/AllUnits.html +++ b/docs/AllUnits.html @@ -4,7 +4,7 @@ Delphi TZDB: All Units - + @@ -26,17 +26,23 @@

Delphi TZDB

Units

< }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

All Units

+TZDB for Delphi Documentation by pasdoc 2018-03-04 +

All Units

+ + + + - +
Name Description
TZCAPI

* Copyright (c) 2013, Ciobanu Alexandru * All rights reserved.

TZDB

General conditional section. Checks for specific RTL "features" shared across FreePascal and different versions of Delphi. Recommended version is Delphi XE though ...

General conditional section.
-prepared by M.Taylor
Generated by PasDoc 0.15.0. +prepared by M.Taylor +
Generated by PasDoc 0.15.0. diff --git a/docs/AllVariables.html b/docs/AllVariables.html index 5728cb4..1101164 100644 --- a/docs/AllVariables.html +++ b/docs/AllVariables.html @@ -4,7 +4,7 @@ Delphi TZDB: All Variables - + @@ -26,9 +26,11 @@

Delphi TZDB

Units

< }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

All Variables

+TZDB for Delphi Documentation by pasdoc 2018-03-04 +

All Variables

The units do not contain any variables.

-prepared by M.Taylor
Generated by PasDoc 0.15.0. +prepared by M.Taylor +
Generated by PasDoc 0.15.0. diff --git a/docs/ClassHierarchy.html b/docs/ClassHierarchy.html index 0c9c26b..31faf98 100644 --- a/docs/ClassHierarchy.html +++ b/docs/ClassHierarchy.html @@ -4,7 +4,7 @@ Delphi TZDB: Class Hierarchy - + @@ -26,18 +26,17 @@

Delphi TZDB

Units

< }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

Class Hierarchy

+TZDB for Delphi Documentation by pasdoc 2018-03-04 +

Class Hierarchy

- -
  • TTimeZone
    • -prepared by M.Taylor
    Generated by PasDoc 0.15.0. +prepared by M.Taylor +
    Generated by PasDoc 0.15.0. diff --git a/docs/Decomposer.TDecomposedPeriod.html b/docs/Decomposer.TDecomposedPeriod.html new file mode 100644 index 0000000..d6c3afd --- /dev/null +++ b/docs/Decomposer.TDecomposedPeriod.html @@ -0,0 +1,173 @@ + + + +Delphi TZDB: Decomposer: Record TDecomposedPeriod + + + + + + + + +
    +

    Delphi TZDB

    Units

    Class Hierarchy

    Classes, Interfaces, Objects and Records

    Types

    Variables

    Constants

    Functions and Procedures

    Identifiers

    +
    + + +    		 +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

    Record TDecomposedPeriod

    +
    +
    Description
    Hierarchy
    Fields
    Methods
    Properties
    +

    Unit

    +

    +Decomposer

    +

    Declaration

    +

    +type TDecomposedPeriod = record

    +

    Description

    + 

    Overview

    +

    Fields

    + + + + + + + + + + + + + + + + + + + +
    FStartsAt: TDateTime;
    FEndsAt: TDateTime;
    FType: TLocalTimeType;
    FAbbrv: string;
    FName: string;
    FBias: TTimeSpan;
    +

    Properties

    + + + + + + + + + + + + + + + + + + + +
    property Abbreviation: string read FAbbrv;
    property Bias: TTimeSpan read FBias;
    property DisplayName: string read FName;
    property EndsAt: TDateTime read FEndsAt;
    property LocalType: TLocalTimeType read FType;
    property StartsAt: TDateTime read FStartsAt;
    +

    Description

    +

    Fields

    + + + + + +
    FStartsAt: TDateTime;
    + 
    + + + + + +
    FEndsAt: TDateTime;
    + 
    + + + + + +
    FType: TLocalTimeType;
    + 
    + + + + + +
    FAbbrv: string;
    + 
    + + + + + +
    FName: string;
    + 
    + + + + + +
    FBias: TTimeSpan;
    + 
    +

    Properties

    + + + + + +
    property Abbreviation: string read FAbbrv;
    + 
    + + + + + +
    property Bias: TTimeSpan read FBias;
    + 
    + + + + + +
    property DisplayName: string read FName;
    + 
    + + + + + +
    property EndsAt: TDateTime read FEndsAt;
    + 
    + + + + + +
    property LocalType: TLocalTimeType read FType;
    + 
    + + + + + +
    property StartsAt: TDateTime read FStartsAt;
    + 
    +prepared by M.Taylor +
    Generated by PasDoc 0.15.0. + +
    diff --git a/docs/Decomposer.html b/docs/Decomposer.html new file mode 100644 index 0000000..48e3520 --- /dev/null +++ b/docs/Decomposer.html @@ -0,0 +1,67 @@ + + + +Delphi TZDB: Decomposer + + + + + + + + +
    +

    Delphi TZDB

    Units

    Class Hierarchy

    Classes, Interfaces, Objects and Records

    Types

    Variables

    Constants

    Functions and Procedures

    Identifiers

    +
    + + +    		 +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

    Unit Decomposer

    +
    +
    Description
    Uses
    Classes, Interfaces, Objects and Records
    Functions and Procedures
    Types
    Constants
    Variables
    +

    Description

    +

    +* Copyright (c) 2010, Ciobanu Alexandru * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * Neither the name of this library nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    +

    Uses

    +
    • SysUtils
    • DateUtils
    • TimeSpan
    • Generics.Collections

    Overview

    +

    Classes, Interfaces, Objects and Records

    + + + + + + + + + +
    NameDescription
    Record TDecomposedPeriod 
    +

    Functions and Procedures

    + + + + +
    function Decompose(const ATimeZone: TTimeZone; const AYear: Word): TList<TDecomposedPeriod>;
    +

    Description

    +

    Functions and Procedures

    + + + + + +
    function Decompose(const ATimeZone: TTimeZone; const AYear: Word): TList<TDecomposedPeriod>;
    + 
    +prepared by M.Taylor +
    Generated by PasDoc 0.15.0. + +
    diff --git a/docs/GVClasses.dot b/docs/GVClasses.dot new file mode 100644 index 0000000..6486b04 --- /dev/null +++ b/docs/GVClasses.dot @@ -0,0 +1,7 @@ +DiGraph Classes { + Exception -> TObject + ETimeZoneInvalid -> Exception + ETimeZoneInvalid [href="TZDB.ETimeZoneInvalid.html"] + TBundledTimeZone -> TTimeZone + TBundledTimeZone [href="TZDB.TBundledTimeZone.html"] +} diff --git a/docs/GVUses.dot b/docs/GVUses.dot new file mode 100644 index 0000000..0885c9c --- /dev/null +++ b/docs/GVUses.dot @@ -0,0 +1,13 @@ +DiGraph Uses { + "Decomposer" -> "SysUtils" + "Decomposer" -> "DateUtils" + "Decomposer" -> "TimeSpan" + "Decomposer" -> "Generics.Collections" + "Decomposer" [href="Decomposer.html"] + "TZCAPI" [href="TZCAPI.html"] + "TZDB" -> "SysUtils" + "TZDB" -> "DateUtils" + "TZDB" -> "Classes" + "TZDB" -> "TimeSpan" + "TZDB" [href="TZDB.html"] +} diff --git a/docs/TZCAPI.TZ_Instance.html b/docs/TZCAPI.TZ_Instance.html new file mode 100644 index 0000000..fa0ce68 --- /dev/null +++ b/docs/TZCAPI.TZ_Instance.html @@ -0,0 +1,71 @@ + + + +Delphi TZDB: TZCAPI: Record TZ_Instance + + + + + + + + +
    +

    Delphi TZDB

    Units

    Class Hierarchy

    Classes, Interfaces, Objects and Records

    Types

    Variables

    Constants

    Functions and Procedures

    Identifiers

    +
    + + +    		 +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

    Record TZ_Instance

    +
    +
    Description
    Hierarchy
    Fields
    Methods
    Properties
    +

    Unit

    +

    +TZCAPI

    +

    Declaration

    +

    +type TZ_Instance = record

    +

    Description

    +

    +<summary>An opaque structure that identifies a time zone object.</summary>

    +

    Overview

    +

    Fields

    + + + + + + + +
    FTZName: PChar;
    FTZObject: Pointer;
    +

    Description

    +

    Fields

    + + + + + +
    FTZName: PChar;
    + 
    + + + + + +
    FTZObject: Pointer;
    + 
    +prepared by M.Taylor +
    Generated by PasDoc 0.15.0. + +
    diff --git a/docs/TZCAPI.html b/docs/TZCAPI.html new file mode 100644 index 0000000..669f8d6 --- /dev/null +++ b/docs/TZCAPI.html @@ -0,0 +1,328 @@ + + + +Delphi TZDB: TZCAPI + + + + + + + + +
    +

    Delphi TZDB

    Units

    Class Hierarchy

    Classes, Interfaces, Objects and Records

    Types

    Variables

    Constants

    Functions and Procedures

    Identifiers

    +
    + + +    		 +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

    Unit TZCAPI

    +
    +
    Description
    Uses
    Classes, Interfaces, Objects and Records
    Functions and Procedures
    Types
    Constants
    Variables
    +

    Description

    +

    +* Copyright (c) 2013, Ciobanu Alexandru * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * Neither the name of this library nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    +

    Overview

    +

    Classes, Interfaces, Objects and Records

    + + + + + + + + + +
    NameDescription
    Record TZ_Instance<summary>An opaque structure that identifies a time zone object.</summary>
    +

    Functions and Procedures

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    function TZ_EnumTimeZones(IncludeAliases: Boolean; Data: Pointer; EnumProc: TZ_EnumProc): Boolean; stdcall;
    function TZ_GetAbbreviation(Instance: PTZ_Instance; Time: TZ_Time; ForceDaylight: Boolean; Abbrev: PChar; AbbrevLen: Integer): TZ_Result; stdcall;
    function TZ_GetDisplayName(Instance: PTZ_Instance; Time: TZ_Time; ForceDaylight: Boolean; DispName: PChar; DispNameLen: Integer): TZ_Result; stdcall;
    function TZ_GetLocalTimeType(Instance: PTZ_Instance; Time: TZ_Time): TZ_Result; stdcall;
    function TZ_GetUtcOffset(Instance: PTZ_Instance; Time: TZ_Time; ForceDaylight: Boolean; Offset: PInteger): TZ_Result; stdcall;
    function TZ_InitInstance(Name: PChar): PTZ_Instance; stdcall;
    function TZ_LocalToUtc(Instance: PTZ_Instance; LocalTime: TZ_Time; ForceDaylight: Boolean; UtcTime: PTZ_Time): TZ_Result; stdcall;
    function TZ_ReleaseInstance(Instance: PTZ_Instance): TZ_Result; stdcall;
    function TZ_UtcToLocal(Instance: PTZ_Instance; UtcTime: TZ_Time; LocalTime: PTZ_Time): TZ_Result; stdcall;
    +

    Types

    + + + + + + + + + + + + + + + + +
    PTZ_Instance = ˆTZ_Instance;
    PTZ_Time = ˆTZ_Time;
    TZ_EnumProc = function(Data: Pointer; Name: PChar): Boolean; stdcall;
    TZ_Result = Integer;
    TZ_Time = Int64;
    +

    Constants

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    ERROR_INST_DISPOSED = -3;
    ERROR_INVALID_ARG = -2;
    ERROR_INVALID_LOCAL_TIME = -4;
    ERROR_UNKNOWN = -1;
    LOCAL_TIME_AMBIGUOUS = 3;
    LOCAL_TIME_DAYLIGHT = 2;
    LOCAL_TIME_INVALID = 4;
    LOCAL_TIME_STANDARD = 1;
    +

    Description

    +

    Functions and Procedures

    + + + + + +
    function TZ_EnumTimeZones(IncludeAliases: Boolean; Data: Pointer; EnumProc: TZ_EnumProc): Boolean; stdcall;
    +

    +<summary>Lists all known/supported time zone names.</summary> <param name="Data">User provided data that is passed along to <paramref name="EnumProc"/>.</param> <param name="IncludeAliases">Pass <c>True</c> to include time zone aliases into the list.</param> <param name="EnumProc">The enumerator procedure called for each item in the list.</param> <returns><c>True</c> is returned if the enumeration process was interrupted by the consumer. <c>False</c> is returned otherwise.</returns>

    +
    + + + + + +
    function TZ_GetAbbreviation(Instance: PTZ_Instance; Time: TZ_Time; ForceDaylight: Boolean; Abbrev: PChar; AbbrevLen: Integer): TZ_Result; stdcall;
    +

    +<summary>Generates an abbreviation string for the given local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time (C format).</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="Abbrev">The output string parameter. Should be allocated.</param> <param name="AbbrevLen">The number of characters that <paramref name="Abbrev"/> can hold (excluding trailing \0).</param> <returns>The length of the actual name. If the value is negative, then an error occured. See <c>ERROR_*</c> constants for possile errors.</returns> <remarks>It is important to note that the consumer must specify an allocated memory block pointed by <paramref name="Abbrev"/>. The <paramref name="AbbrevLen"/> parameter must contain the number of bytes allocated. This method will fill this memory with the actual abbreviation and return the actual length of the abbreviation. There may be cases when the passed memory block is smaller than the actual length of the abbreviation. In those cases, only the part that will fit will be copied into the provided memory block.</remarks>

    +
    + + + + + +
    function TZ_GetDisplayName(Instance: PTZ_Instance; Time: TZ_Time; ForceDaylight: Boolean; DispName: PChar; DispNameLen: Integer): TZ_Result; stdcall;
    +

    +<summary>Generates a diplay name for the given local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time (C format).</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="DispName">The output string parameter. Should be allocated.</param> <param name="DispNameLen">The number of characters that <paramref name="DispName"/> can hold (excluding trailing \0).</param> <returns>The length of the actual name. If the value is negative, then an error occured. See <c>ERROR_*</c> constants for possile errors.</returns> <remarks>It is important to note that the consumer must specify an allocated memory block pointed by <paramref name="DispName"/>. The <paramref name="DispNameLen"/> parameter must contain the number of bytes allocated. This method will fill this memory with the actual name and return the actual length of the name. There may be cases when the passed memory block is smaller than the actual length of the name. In those cases, only the part that will fit will be copied into the provided memory block.</remarks>

    +
    + + + + + +
    function TZ_GetLocalTimeType(Instance: PTZ_Instance; Time: TZ_Time): TZ_Result; stdcall;
    +

    +<summary>Returns the type of the local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time.</param> <returns>A zero or a positive result means success. See <c>LOCAL_TIME_*</c> constants for possible types. See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns>

    +
    + + + + + +
    function TZ_GetUtcOffset(Instance: PTZ_Instance; Time: TZ_Time; ForceDaylight: Boolean; Offset: PInteger): TZ_Result; stdcall;
    +

    +<summary>Returns the UTC offset of the given local time.</summary> <param name="Instance">The time zone instance.</param> <param name="Time">The local time.</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="TimeType">An output parameter to which the UTC offset if copied.</param> <returns>A zero or a positive value means success. See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns>

    +
    + + + + + +
    function TZ_InitInstance(Name: PChar): PTZ_Instance; stdcall;
    +

    +<summary>Looks up a time zone object by the given <paramref name="Name"/>.</summary> <param name="Name">The name time zone name to lookup. A <c>nil</c> value will be ignored.</param> <returns>A <c>Pointer</c> to a data structure containing the time zone object. Should be treated as an opaque <c>Pointer</c> by consumers. A <c>nil</c> value is returned if the time zone cannot be looked up.</returns>

    +
    + + + + + +
    function TZ_LocalToUtc(Instance: PTZ_Instance; LocalTime: TZ_Time; ForceDaylight: Boolean; UtcTime: PTZ_Time): TZ_Result; stdcall;
    +

    +<summary>Converts a local time to UTC time.</summary> <param name="Instance">The time zone instance.</param> <param name="LocalTime">The local time to be converted.</param> <param name="ForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <param name="UtcTime">The output parameter to hold the converted UTC time.</param> <returns>A zero or a positive value means success. See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns>

    +
    + + + + + +
    function TZ_ReleaseInstance(Instance: PTZ_Instance): TZ_Result; stdcall;
    +

    +<summary>Releases a previously acquired instance.</summary> <param name="Instance">The time zone instance.</param> <returns>A zero or a positive value means success. See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns>

    +
    + + + + + +
    function TZ_UtcToLocal(Instance: PTZ_Instance; UtcTime: TZ_Time; LocalTime: PTZ_Time): TZ_Result; stdcall;
    +

    +<summary>Converts an UTC time to a local time.</summary> <param name="Instance">The time zone instance.</param> <param name="UtcTime">The UTC time to be converted.</param> <param name="LocalTime">The output parameter to hold the converted local time.</param> <returns>A zero or a positive value means success. See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns>

    +
    +

    Types

    + + + + + +
    PTZ_Instance = ˆTZ_Instance;
    +

    +<summary>A <c>Pointer</c> to a <see cref="TZCAPI|TZ_Instance"/> stucture.</summary>

    +
    + + + + + +
    PTZ_Time = ˆTZ_Time;
    +

    +<summary>A <c>Pointer</c> to a <see cref="TZCAPI|TZ_Time"/> type.</summary>

    +
    + + + + + +
    TZ_EnumProc = function(Data: Pointer; Name: PChar): Boolean; stdcall;
    +

    +<summary>Time zone enumerator procedure.</summary> <param name="Data">A data object provided by the consumer code.</param> <param name="Name">The name of the currently enumerated time zone.</param> <returns>Consmer must return <c>True</c> to interrupt the enumeraton process.</returns>

    +
    + + + + + +
    TZ_Result = Integer;
    +

    +<summary>A somewhat generic type used for most API methods in this library.</summary> <remarks>All negative values of this type signify an error. See <c>ERROR_*</c> constants for reference. Zero and the positive spectrum of values is function dependant. Each function will provide appropriate documentation.</remarks>

    +
    + + + + + +
    TZ_Time = Int64;
    +

    +<summary>An <c>Int64</c> representing the C/UNIX time format.</summary>

    +
    +

    Constants

    + + + + + +
    ERROR_INST_DISPOSED = -3;
    +

    +<summary>The time zone instance passed to the function was detected as being disposed.</summary>

    +
    + + + + + +
    ERROR_INVALID_ARG = -2;
    +

    +<summary>An argument passed to the function was invalid.</summary>

    +
    + + + + + +
    ERROR_INVALID_LOCAL_TIME = -4;
    +

    +<summary>The local time value passed to the function was invalid in the given time zone.</summary>

    +
    + + + + + +
    ERROR_UNKNOWN = -1;
    +

    +<summary>A generic error. Source or cause unknwown.</summary>

    +
    + + + + + +
    LOCAL_TIME_AMBIGUOUS = 3;
    +

    +<summary>The local time is in DST -> Standard year period.</summary>

    +
    + + + + + +
    LOCAL_TIME_DAYLIGHT = 2;
    +

    +<summary>The local time is in the DST year period.</summary>

    +
    + + + + + +
    LOCAL_TIME_INVALID = 4;
    +

    +<summary>The local time is in the Standard -> DST year period.</summary>

    +
    + + + + + +
    LOCAL_TIME_STANDARD = 1;
    +

    +<summary>The local time is in the Standard year period.</summary>

    +
    +prepared by M.Taylor +
    Generated by PasDoc 0.15.0. + +
    diff --git a/docs/TZDB.ELocalTimeInvalid.html b/docs/TZDB.ELocalTimeInvalid.html new file mode 100644 index 0000000..9db8835 --- /dev/null +++ b/docs/TZDB.ELocalTimeInvalid.html @@ -0,0 +1,47 @@ + + + +Delphi TZDB: TZDB: Class ELocalTimeInvalid + + + + + + + + +
    +

    Delphi TZDB

    Units

    Class Hierarchy

    Classes, Interfaces, Objects and Records

    Types

    Variables

    Constants

    Functions and Procedures

    Identifiers

    +
    + + +    		 +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

    Class ELocalTimeInvalid

    +
    +
    Description
    Hierarchy
    Fields
    Methods
    Properties
    +

    Unit

    +

    +TZDB

    +

    Declaration

    +

    +type ELocalTimeInvalid = class(Exception)

    +

    Description

    +

    +<summary>Exception thrown when the passed local time is invalid.</summary>

    +

    Hierarchy

    +
    • Exception
      • +
    • ELocalTimeInvalid
    prepared by M.Taylor +
    Generated by PasDoc 0.15.0. + +
    diff --git a/docs/TZDB.ETimeZoneInvalid.html b/docs/TZDB.ETimeZoneInvalid.html index d5adcd3..c5aaf19 100644 --- a/docs/TZDB.ETimeZoneInvalid.html +++ b/docs/TZDB.ETimeZoneInvalid.html @@ -4,7 +4,7 @@ Delphi TZDB: TZDB: Class ETimeZoneInvalid - + @@ -26,7 +26,8 @@

    Delphi TZDB

    Units

    < }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

    Class ETimeZoneInvalid

    +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

    Class ETimeZoneInvalid

    Description
    Hierarchy
    Fields
    Methods
    Properties

    Unit

    @@ -37,9 +38,10 @@

    Declaration

    type ETimeZoneInvalid = class(Exception)

    Description

    -Exception type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.

    +<summary>Exception type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.</summary>

    Hierarchy

    • Exception
      • -
    • ETimeZoneInvalid
    prepared by M.Taylor
    Generated by PasDoc 0.15.0. +
  • ETimeZoneInvalid
    • prepared by M.Taylor +
    Generated by PasDoc 0.15.0. diff --git a/docs/TZDB.TBundledTimeZone.html b/docs/TZDB.TBundledTimeZone.html index 106ff7f..169fe62 100644 --- a/docs/TZDB.TBundledTimeZone.html +++ b/docs/TZDB.TBundledTimeZone.html @@ -4,7 +4,7 @@ Delphi TZDB: TZDB: Class TBundledTimeZone - + @@ -26,22 +26,21 @@

    Delphi TZDB

    Units

    < }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

    Class TBundledTimeZone

    +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

    Class TBundledTimeZone

    -
    Description
    Hierarchy
    Fields
    Methods
    Properties
    +
    Description
    Hierarchy
    Fields
    Methods
    Properties

    Unit

    TZDB

    Declaration

    -type TBundledTimeZone = class(TTimeZone)

    +type TBundledTimeZone = class(TObject)

    Description

    -A timezone class implementation that retreives its data from the bundled database.

    -

    - This class inherits the standard TTimeZone class in Delphi XE.

    +<summary>A timezone class implementation that retreives its data from the bundled database.</summary> <remarks>This class inherits the standard <c>TTimeZone</c> class in Delphi XE.</remarks>

    Hierarchy

    -
    • TTimeZone
      • +
      • TObject
      • TBundledTimeZone

      Overview

      Methods

      @@ -55,23 +54,74 @@

      Description

      + + + + + + + + + + + + + + + + - + - - + + - - + + + + + + + + + + + + + + + + + + - + + +
      Publicfunction GetAbbreviation(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): string;
      Publicfunction GetDisplayName(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): string;
      Publicfunction GetLocalTimeType(const ADateTime: TDateTime): TLocalTimeType;
      Public class function GetTimeZone(const ATimeZoneID: string): TBundledTimeZone;
      Publicfunction GetUtcOffset(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): Int64;
      Publicclass function KnownTimeZones(const AIncludeAliases: Boolean = False): TArray<string>;function IsAmbiguousTime(const ADateTime: TDateTime): Boolean;
      Protectedfunction DoGetDisplayName(const ADateTime: TDateTime; const ForceDaylight: Boolean): string; override;Publicfunction IsDaylightTime(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): Boolean;
      Protectedfunction DoGetID: string; override;Publicfunction IsInvalidTime(const ADateTime: TDateTime): Boolean;
      Publicfunction IsStandardTime(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): Boolean;
      Publicclass function KnownTimeZones(const AIncludeAliases: Boolean = False): TStringDynArray;
      Publicfunction ToLocalTime(const ADateTime: TDateTime): TDateTime;
      Publicfunction ToUniversalTime(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): TDateTime;
      Protectedprocedure DoGetOffsetsAndType( const ADateTime: TDateTime; out AOffset, ADstSave: Int64; out AType: TLocalTimeType); override;function DoGetID: string;
      +

      Properties

      + + + + + + + + + + + + + + + +
      Publicproperty Abbreviation: string read GetCurrentAbbreviation;
      Publicproperty DisplayName: string read GetCurrentDisplayName;
      Publicproperty ID: string read DoGetID;
      Publicproperty UtcOffset: Int64 read GetCurrentUtcOffset;

      Description

      @@ -83,21 +133,7 @@

      Methods

      -Creates a new instance of this timezone class.

      -

      - - -

      -
      Parameters
      -
      -
      ATimeZoneID
      -
      The ID of the timezone to use (ex. "Europe/Bucharest").
      -
      -
      Exceptions raised
      -
      -
      UNKNOWN
      -
      specified ID cannot be found in the bundled database.
      -
      +<summary>Creates a new instance of this timezone class.</summary> <param name="ATimeZoneID">The ID of the timezone to use (ex. "Europe/Bucharest").</param> <exception cref="TZDB|ETimeZoneInvalid">The specified ID cannot be found in the bundled database.</exception>

      @@ -107,7 +143,37 @@
      Exceptions raised
      +

      -Destroys the current instance.

      +<summary>Destroys the current instance.</summary>

      +
      + + + + + + +
      Publicfunction GetAbbreviation(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): string;
      +

      +<summary>Generates an abbreviation string for the given local time.</summary> <param name="ADateTime">The local time.</param> <param name="AForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <returns>A string containing the abbreviation.</returns> <exception cref="TZDB|ELocalTimeInvalid">The specified local time is invalid.</exception>

      +
      + + + + + + +
      Publicfunction GetDisplayName(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): string;
      +

      +<summary>Generates a diplay string for the given local time.</summary> <param name="ADateTime">The local time.</param> <param name="AForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <returns>A string containing the display name.</returns> <exception cref="TZDB|ELocalTimeInvalid">The specified local time is invalid.</exception>

      +
      + + + + + +
      Publicfunction GetLocalTimeType(const ADateTime: TDateTime): TLocalTimeType;
      +

      +<summary>Returns the type of the local time.</summary> <param name="ADateTime">The local time.</param> <returns>An enumeration value specifying the type of the local time.</returns>

      @@ -117,115 +183,141 @@
      Exceptions raised
      +

      -Returns an instance of this time zone class.

      +<summary>Returns an instance of this time zone class.</summary> <param name="ATimeZoneID">The ID of the timezone to use (ex. "Europe/Bucharest").</param> <exception cref="TZDB|ETimeZoneInvalid">The specified ID cannot be found in the bundled database.</exception>

      +
      + + + + + +
      Publicfunction GetUtcOffset(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): Int64;

      - - -

      -
      Parameters
      -
      -
      ATimeZoneID
      -
      The ID of the timezone to use (ex. "Europe/Bucharest").
      -
      -
      Exceptions raised
      -
      -
      UNKNOWN
      -
      specified ID cannot be found in the bundled database.
      -
      +<summary>Returns the UTC offset of the given local time.</summary> <param name="ADateTime">The local time.</param> <param name="AForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <returns>The UTC offset of the given local time. Subtract this value from the passed local time to obtain an UTC time.</returns> <exception cref="TZDB|ELocalTimeInvalid">The specified local time is invalid.</exception>

      - + +
      Publicclass function KnownTimeZones(const AIncludeAliases: Boolean = False): TArray<string>;function IsAmbiguousTime(const ADateTime: TDateTime): Boolean;

      -Returns a list of known time zones.

      +<summary>Checks whether the specified local time is ambiguous.</summary> <param name="ADateTime">The local time.</param> <returns><c>True</c> if the local time is ambiguous; <c>False</c> otherwise.</returns>

      +
      + + + + + + +<summary>Checks whether the specified local time is daylight.</summary> <param name="ADateTime">The local time.</param> <param name="AForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <returns><c>True</c> if the local time is ambiguous; <c>False</c> otherwise.</returns>

      +
      Publicfunction IsDaylightTime(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): Boolean;

      - - -

      -
      Parameters
      -
      -
      AIncludeAliases
      -
      Pass True to include time zone aliases into the list.
      -
      -
      Returns
      -

      An array of strings representing the IDs of the known time zones.

      - - + + +
      Protectedfunction DoGetDisplayName(const ADateTime: TDateTime; const ForceDaylight: Boolean): string; override;Publicfunction IsInvalidTime(const ADateTime: TDateTime): Boolean;

      -Retrieves the display name for the time zone based on a given local time.

      +<summary>Checks whether the specified local time is invalid.</summary> <param name="ADateTime">The local time.</param> <returns><c>True</c> if the local time is invalid; <c>False</c> otherwise.</returns>

      +
      + + + + + + +
      Publicfunction IsStandardTime(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): Boolean;

      - - +<summary>Checks whether the specified local time is standard.</summary> <param name="ADateTime">The local time.</param> <param name="AForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <returns><c>True</c> if the local time is standard; <c>False</c> otherwise.</returns>

      +
      + + + + + + +<summary>Returns a list of known time zones.</summary> <param name="AIncludeAliases">Pass <c>True</c> to include time zone aliases into the list.</param> <returns>An array of strings representing the IDs of the known time zones.</returns>

      +
      Publicclass function KnownTimeZones(const AIncludeAliases: Boolean = False): TStringDynArray;

      - -

      -
      Parameters
      -
      -
      ADateTime
      -
      The local time for which to retrieve the display name.
      -
      1
      -
      Forces the timezone class to select the DST display name if the local time is whithin the ambiguous period.
      -
      -
      Returns
      -

      The display name used to accompany the given local time.

      - - + + +
      Protectedfunction DoGetID: string; override;Publicfunction ToLocalTime(const ADateTime: TDateTime): TDateTime;

      -Returns the ID of the timezone. An ID is a string that should uniquely identify the timezone.

      +<summary>Converts an UTC time to a local time.</summary> <param name="ADateTime">The UTC time.</param> <returns>The local time that corresponds to the passed UTC time.</returns>

      +
      + + + + + + +<summary>Converts a local time to an UTC time.</summary> <param name="ADateTime">The local time.</param> <param name="AForceDaylight">Specify a <c>True</c> value if ambiguous periods should be treated as DST.</param> <returns>The UTC time that corresponds to the passed local time.</returns> <exception cref="TZDB|ELocalTimeInvalid">The specified local time is invalid.</exception>

      +
      Publicfunction ToUniversalTime(const ADateTime: TDateTime; const AForceDaylight: Boolean = false): TDateTime;

      -

      -
      Returns
      -

      The ID of the timezone.

      - + +
      Protectedprocedure DoGetOffsetsAndType( const ADateTime: TDateTime; out AOffset, ADstSave: Int64; out AType: TLocalTimeType); override;function DoGetID: string;

      -Retrieves the standard bias, DST bias and the type of the given local time.

      +<summary>Returns the ID of the timezone. An ID is a string that should uniquely identify the timezone.</summary> <returns>The ID of the timezone.</returns>

      +
      +

      Properties

      + + + + + + +
      Publicproperty Abbreviation: string read GetCurrentAbbreviation;

      - - +<summary>Returns the current time zone's abbreviation string.</summary> <returns>A string containing the abbreviation.</returns>

      +
      + + + + + + +
      Publicproperty DisplayName: string read GetCurrentDisplayName;

      - +<summary>Returns the current time zone's display name string.</summary> <returns>A string containing the display name.</returns>

      +
      + + + + + + +
      Publicproperty ID: string read DoGetID;

      - +<summary>Returns the ID of the timezone. An ID is a string that should uniquely identify the timezone.</summary> <returns>The ID of the timezone.</returns>

      +
      + + + + + + -
      Publicproperty UtcOffset: Int64 read GetCurrentUtcOffset;

      - -

      The value of - -

      is only relevant if - -

      is lttAmbiguous or lttDaylight.

      -
      Parameters
      -
      -
      ADateTime
      -
      The local time for which to retrieve the data.
      -
      1
      -
      The returned standard bias of the time zone for the given time.
      -
      1
      -
      The returned DST bias of the time zone for the given time.
      -
      1
      -
      The returned type of the local time.
      -
      -
      -prepared by M.Taylor
      Generated by PasDoc 0.15.0. +<summary>Returns the current time zone's UTC offset.</summary> <returns>The current UTC offset.</returns>

      + + +prepared by M.Taylor +
      Generated by PasDoc 0.15.0. diff --git a/docs/TZDB.html b/docs/TZDB.html index 66fd760..3dea94b 100644 --- a/docs/TZDB.html +++ b/docs/TZDB.html @@ -4,7 +4,7 @@ Delphi TZDB: TZDB - + @@ -26,14 +26,15 @@

      Delphi TZDB

      Units

      < }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

      Unit TZDB

      +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

      Unit TZDB

      -
      Description
      Uses
      Classes, Interfaces, Objects and Records
      Functions and Procedures
      Types
      Constants
      Variables
      +
      Description
      Uses
      Classes, Interfaces, Objects and Records
      Functions and Procedures
      Types
      Constants
      Variables

      Description

      General conditional section. Checks for specific RTL "features" shared across FreePascal and different versions of Delphi. Recommended version is Delphi XE though ...

      Uses

      -
      • SysUtils
      • DateUtils
      • Classes
      • TimeSpan

      Overview

      +
      • SysUtils
      • DateUtils
      • Classes
      • Types

      Overview

      Classes, Interfaces, Objects and Records

      @@ -41,14 +42,47 @@

      Delphi TZDB

      Units

      < - - + + + + + + - +
      Description
      Class ETimeZoneInvalidException type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.Class ELocalTimeInvalid<summary>Exception thrown when the passed local time is invalid.</summary>
      Class ETimeZoneInvalid<summary>Exception type used to signal the caller code that a requested time zone is not present in the bundled database or that its format is invalid.</summary>
      Class TBundledTimeZoneA timezone class implementation that retreives its data from the bundled database.<summary>A timezone class implementation that retreives its data from the bundled database.</summary> <remarks>This class inherits the standard <c>TTimeZone</c> class in Delphi XE.</remarks>
      -prepared by M.Taylor
      Generated by PasDoc 0.15.0. +

      Types

      + + + + +
      TLocalTimeType = (...);
      +

      Description

      +

      Types

      + + + + + +
      TLocalTimeType = (...);
      +

      +<summary>Defines four types that a local date/time type can be in.</summary>

      +
      Values
      +
        +
      • +lttStandard: <summary>The local time is in the Standard year period.</summary>
        • +
      • +lttDaylight: <summary>The local time is in the DST year period.</summary>
        • +
      • +lttAmbiguous: <summary>The local time is in DST -> Standard year period.</summary>
        • +
      • +lttInvalid: <summary>The local time is in the Standard -> DST year period.</summary>
        • +
      +
      +prepared by M.Taylor +
      Generated by PasDoc 0.15.0. diff --git a/docs/_tipue_results.html b/docs/_tipue_results.html index 53ff1ee..f207c7a 100644 --- a/docs/_tipue_results.html +++ b/docs/_tipue_results.html @@ -5,7 +5,7 @@ - + diff --git a/docs/index.html b/docs/index.html index 0453daf..8d8c787 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,7 +4,7 @@ Delphi TZDB: All Units - + @@ -26,17 +26,23 @@

      Delphi TZDB

      Units

      < }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

      All Units

      +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

      All Units

      + + + + - +
      Name Description
      TZCAPI

      * Copyright (c) 2013, Ciobanu Alexandru * All rights reserved.

      TZDB

      General conditional section. Checks for specific RTL "features" shared across FreePascal and different versions of Delphi. Recommended version is Delphi XE though ...

      General conditional section.
      -prepared by M.Taylor
      Generated by PasDoc 0.15.0. +prepared by M.Taylor +
      Generated by PasDoc 0.15.0. diff --git a/docs/legend.html b/docs/legend.html index 72c1988..59ae0f8 100644 --- a/docs/legend.html +++ b/docs/legend.html @@ -4,7 +4,7 @@ Delphi TZDB: Legend - + @@ -26,7 +26,8 @@

      Delphi TZDB

      Units

      < }); -TZDB for Delphi Documentation by pasdoc 2018-03-04

      Legend

      +TZDB for Delphi Documentation by pasdoc 2018-03-04 +

      Legend

      @@ -65,6 +66,7 @@

      Delphi TZDB

      Units

      <
      MarkerImplicit
      -prepared by M.Taylor
      Generated by PasDoc 0.15.0. +prepared by M.Taylor +
      Generated by PasDoc 0.15.0. diff --git a/docs/tipuesearch/tipuesearch_data.js b/docs/tipuesearch/tipuesearch_data.js index 01b68ed..24e0609 100644 --- a/docs/tipuesearch/tipuesearch_data.js +++ b/docs/tipuesearch/tipuesearch_data.js @@ -1,12 +1,52 @@ var tipuesearch = {"pages": [ - {"title": "TZDB", "text": "General conditional section. Checks for specific RTL "features" shared across FreePascal and different versions of Delphi. Recommended version is Delphi XE though ... ", "tags": "", "loc": "TZDB.html"}, + {"title": "TZCAPI", "text": " * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * Neither the name of this library nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ", "tags": "", "loc": "TZCAPI.html"}, + {"title": "TZCAPI.TZ_Instance", "text": " ", "tags": "", "loc": "TZCAPI.TZ_Instance.html"}, + {"title": "TZCAPI.TZ_Instance.FTZName", "text": " ", "tags": "", "loc": "TZCAPI.TZ_Instance.html#FTZName"}, + {"title": "TZCAPI.TZ_Instance.FTZObject", "text": " ", "tags": "", "loc": "TZCAPI.TZ_Instance.html#FTZObject"}, + {"title": "TZCAPI.ERROR_INST_DISPOSED", "text": " ", "tags": "", "loc": "TZCAPI.html#ERROR_INST_DISPOSED"}, + {"title": "TZCAPI.ERROR_INVALID_ARG", "text": " ", "tags": "", "loc": "TZCAPI.html#ERROR_INVALID_ARG"}, + {"title": "TZCAPI.ERROR_INVALID_LOCAL_TIME", "text": " ", "tags": "", "loc": "TZCAPI.html#ERROR_INVALID_LOCAL_TIME"}, + {"title": "TZCAPI.ERROR_UNKNOWN", "text": " Source or cause unknwown.</summary> ", "tags": "", "loc": "TZCAPI.html#ERROR_UNKNOWN"}, + {"title": "TZCAPI.LOCAL_TIME_AMBIGUOUS", "text": " ", "tags": "", "loc": "TZCAPI.html#LOCAL_TIME_AMBIGUOUS"}, + {"title": "TZCAPI.LOCAL_TIME_DAYLIGHT", "text": " ", "tags": "", "loc": "TZCAPI.html#LOCAL_TIME_DAYLIGHT"}, + {"title": "TZCAPI.LOCAL_TIME_INVALID", "text": " ", "tags": "", "loc": "TZCAPI.html#LOCAL_TIME_INVALID"}, + {"title": "TZCAPI.LOCAL_TIME_STANDARD", "text": " ", "tags": "", "loc": "TZCAPI.html#LOCAL_TIME_STANDARD"}, + {"title": "TZCAPI.TZ_EnumTimeZones", "text": " <c>False</c> is returned otherwise.</returns> ", "tags": "", "loc": "TZCAPI.html#TZ_EnumTimeZones"}, + {"title": "TZCAPI.TZ_GetAbbreviation", "text": " Should be allocated.</param> <param name="AbbrevLen">The number of characters that <paramref name="Abbrev"/> can hold (excluding trailing \\0).</param> <returns>The length of the actual name. If the value is negative, then an error occured. See <c>ERROR_*</c> constants for possile errors.</returns> <remarks>It is important to note that the consumer must specify an allocated memory block pointed by <paramref name="Abbrev"/>. The <paramref name="AbbrevLen"/> parameter must contain the number of bytes allocated. This method will fill this memory with the actual abbreviation and return the actual length of the abbreviation. There may be cases when the passed memory block is smaller than the actual length of the abbreviation. In those cases, only the part that will fit will be copied into the provided memory block.</remarks> ", "tags": "", "loc": "TZCAPI.html#TZ_GetAbbreviation"}, + {"title": "TZCAPI.TZ_GetDisplayName", "text": " Should be allocated.</param> <param name="DispNameLen">The number of characters that <paramref name="DispName"/> can hold (excluding trailing \\0).</param> <returns>The length of the actual name. If the value is negative, then an error occured. See <c>ERROR_*</c> constants for possile errors.</returns> <remarks>It is important to note that the consumer must specify an allocated memory block pointed by <paramref name="DispName"/>. The <paramref name="DispNameLen"/> parameter must contain the number of bytes allocated. This method will fill this memory with the actual name and return the actual length of the name. There may be cases when the passed memory block is smaller than the actual length of the name. In those cases, only the part that will fit will be copied into the provided memory block.</remarks> ", "tags": "", "loc": "TZCAPI.html#TZ_GetDisplayName"}, + {"title": "TZCAPI.TZ_GetLocalTimeType", "text": " See <c>LOCAL_TIME_*</c> constants for possible types. See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns> ", "tags": "", "loc": "TZCAPI.html#TZ_GetLocalTimeType"}, + {"title": "TZCAPI.TZ_GetUtcOffset", "text": " See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns> ", "tags": "", "loc": "TZCAPI.html#TZ_GetUtcOffset"}, + {"title": "TZCAPI.TZ_InitInstance", "text": " A <c>nil</c> value will be ignored.</param> <returns>A <c>Pointer</c> to a data structure containing the time zone object. Should be treated as an opaque <c>Pointer</c> by consumers. A <c>nil</c> value is returned if the time zone cannot be looked up.</returns> ", "tags": "", "loc": "TZCAPI.html#TZ_InitInstance"}, + {"title": "TZCAPI.TZ_LocalToUtc", "text": " See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns> ", "tags": "", "loc": "TZCAPI.html#TZ_LocalToUtc"}, + {"title": "TZCAPI.TZ_ReleaseInstance", "text": " See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns> ", "tags": "", "loc": "TZCAPI.html#TZ_ReleaseInstance"}, + {"title": "TZCAPI.TZ_UtcToLocal", "text": " See <c>ERROR_*</c> constants for possile errors (if the value is negative).</returns> ", "tags": "", "loc": "TZCAPI.html#TZ_UtcToLocal"}, + {"title": "TZCAPI.PTZ_Instance", "text": " ", "tags": "", "loc": "TZCAPI.html#PTZ_Instance"}, + {"title": "TZCAPI.PTZ_Time", "text": " ", "tags": "", "loc": "TZCAPI.html#PTZ_Time"}, + {"title": "TZCAPI.TZ_EnumProc", "text": " ", "tags": "", "loc": "TZCAPI.html#TZ_EnumProc"}, + {"title": "TZCAPI.TZ_Result", "text": " See <c>ERROR_*</c> constants for reference. Zero and the positive spectrum of values is function dependant. Each function will provide appropriate documentation.</remarks> ", "tags": "", "loc": "TZCAPI.html#TZ_Result"}, + {"title": "TZCAPI.TZ_Time", "text": " ", "tags": "", "loc": "TZCAPI.html#TZ_Time"}, + {"title": "TZDB", "text": " Checks for specific RTL "features" shared across FreePascal and different versions of Delphi. Recommended version is Delphi XE though ... ", "tags": "", "loc": "TZDB.html"}, + {"title": "TZDB.ELocalTimeInvalid", "text": " ", "tags": "", "loc": "TZDB.ELocalTimeInvalid.html"}, {"title": "TZDB.ETimeZoneInvalid", "text": " ", "tags": "", "loc": "TZDB.ETimeZoneInvalid.html"}, - {"title": "TZDB.TBundledTimeZone", "text": " This class inherits the standard TTimeZone class in Delphi XE. ", "tags": "", "loc": "TZDB.TBundledTimeZone.html"}, - {"title": "TZDB.TBundledTimeZone.Create", "text": "

      ATimeZoneID The ID of the timezone to use (ex. "Europe/Bucharest"). cref="TZDB|ETimeZoneInvalid"The specified ID cannot be found in the bundled database.", "tags": "", "loc": "TZDB.TBundledTimeZone.html#Create"}, + {"title": "TZDB.TBundledTimeZone", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html"}, + {"title": "TZDB.TBundledTimeZone.Create", "text": " "Europe/Bucharest").</param> <exception cref="TZDB|ETimeZoneInvalid">The specified ID cannot be found in the bundled database.</exception> ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#Create"}, {"title": "TZDB.TBundledTimeZone.Destroy", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#Destroy"}, - {"title": "TZDB.TBundledTimeZone.GetTimeZone", "text": "

      ATimeZoneID The ID of the timezone to use (ex. "Europe/Bucharest"). cref="TZDB|ETimeZoneInvalid"The specified ID cannot be found in the bundled database.", "tags": "", "loc": "TZDB.TBundledTimeZone.html#GetTimeZone"}, - {"title": "TZDB.TBundledTimeZone.KnownTimeZones", "text": "

      AIncludeAliases Pass True to include time zone aliases into the list. An array of strings representing the IDs of the known time zones. ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#KnownTimeZones"}, - {"title": "TZDB.TBundledTimeZone.DoGetDisplayName", "text": "

      ADateTime The local time for which to retrieve the display name. 1 Forces the timezone class to select the DST display name if the local time is whithin the ambiguous period. The display name used to accompany the given local time. ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#DoGetDisplayName"}, - {"title": "TZDB.TBundledTimeZone.DoGetID", "text": " The ID of the timezone. ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#DoGetID"}, - {"title": "TZDB.TBundledTimeZone.DoGetOffsetsAndType", "text": "

      The value of

      is only relevant if

      is lttAmbiguous or lttDaylight. ADateTime The local time for which to retrieve the data. 1 The returned standard bias of the time zone for the given time. 1 The returned DST bias of the time zone for the given time. 1 The returned type of the local time. ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#DoGetOffsetsAndType"} + {"title": "TZDB.TBundledTimeZone.GetAbbreviation", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#GetAbbreviation"}, + {"title": "TZDB.TBundledTimeZone.GetDisplayName", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#GetDisplayName"}, + {"title": "TZDB.TBundledTimeZone.GetLocalTimeType", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#GetLocalTimeType"}, + {"title": "TZDB.TBundledTimeZone.GetTimeZone", "text": " "Europe/Bucharest").</param> <exception cref="TZDB|ETimeZoneInvalid">The specified ID cannot be found in the bundled database.</exception> ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#GetTimeZone"}, + {"title": "TZDB.TBundledTimeZone.GetUtcOffset", "text": " Subtract this value from the passed local time to obtain an UTC time.</returns> <exception cref="TZDB|ELocalTimeInvalid">The specified local time is invalid.</exception> ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#GetUtcOffset"}, + {"title": "TZDB.TBundledTimeZone.IsAmbiguousTime", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#IsAmbiguousTime"}, + {"title": "TZDB.TBundledTimeZone.IsDaylightTime", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#IsDaylightTime"}, + {"title": "TZDB.TBundledTimeZone.IsInvalidTime", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#IsInvalidTime"}, + {"title": "TZDB.TBundledTimeZone.IsStandardTime", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#IsStandardTime"}, + {"title": "TZDB.TBundledTimeZone.KnownTimeZones", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#KnownTimeZones"}, + {"title": "TZDB.TBundledTimeZone.ToLocalTime", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#ToLocalTime"}, + {"title": "TZDB.TBundledTimeZone.ToUniversalTime", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#ToUniversalTime"}, + {"title": "TZDB.TBundledTimeZone.DoGetID", "text": " An ID is a string that should uniquely identify the timezone.</summary> <returns>The ID of the timezone.</returns> ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#DoGetID"}, + {"title": "TZDB.TBundledTimeZone.Abbreviation", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#Abbreviation"}, + {"title": "TZDB.TBundledTimeZone.DisplayName", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#DisplayName"}, + {"title": "TZDB.TBundledTimeZone.ID", "text": " An ID is a string that should uniquely identify the timezone.</summary> <returns>The ID of the timezone.</returns> ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#ID"}, + {"title": "TZDB.TBundledTimeZone.UtcOffset", "text": " ", "tags": "", "loc": "TZDB.TBundledTimeZone.html#UtcOffset"}, + {"title": "TZDB.TLocalTimeType", "text": " lttStandard <summary>The local time is in the Standard year period.</summary> lttDaylight <summary>The local time is in the DST year period.</summary> lttAmbiguous <summary>The local time is in DST -> Standard year period.</summary> lttInvalid <summary>The local time is in the Standard -> DST year period.</summary> ", "tags": "", "loc": "TZDB.html#TLocalTimeType"} ]}; diff --git a/src/TZDBPK/Version.inc b/src/TZDBPK/Version.inc index a68802b..e409e04 100644 --- a/src/TZDBPK/Version.inc +++ b/src/TZDBPK/Version.inc @@ -1,4 +1,4 @@ - +{$IFNDEF PASDOC} {$DEFINE UNSUPPORTED_VERSION} {$IFDEF FPC} {$IFNDEF VER1_0} @@ -36,4 +36,5 @@ {$ENDIF} {$IFDEF UNSUPPORTED_VERSION} {$MESSAGE ERROR 'TZDB requires at least Delphi 6 or FreePascal 2.0 to compile!'} -{$ENDIF} \ No newline at end of file +{$ENDIF} +{$ENDIF}