| ELocalTimeInvalid |
TZDB |
<summary>Exception thrown when the passed local time is invalid.</summary> |
| ERROR_INST_DISPOSED |
TZCAPI |
<summary>The time zone instance passed to the function was detected as being disposed.</summary> |
| ERROR_INVALID_ARG |
TZCAPI |
<summary>An argument passed to the function was invalid.</summary> |
| ERROR_INVALID_LOCAL_TIME |
TZCAPI |
<summary>The local time value passed to the function was invalid in the given time zone.</summary> |
| ERROR_UNKNOWN |
TZCAPI |
<summary>A generic error. |
| ETimeZoneInvalid |
TZDB |
<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_AMBIGUOUS |
TZCAPI |
<summary>The local time is in DST -> Standard year period.</summary> |
| LOCAL_TIME_DAYLIGHT |
TZCAPI |
<summary>The local time is in the DST year period.</summary> |
| LOCAL_TIME_INVALID |
TZCAPI |
<summary>The local time is in the Standard -> DST year period.</summary> |
| LOCAL_TIME_STANDARD |
TZCAPI |
<summary>The local time is in the Standard year period.</summary> |
| PTZ_Instance |
TZCAPI |
<summary>A <c>Pointer</c> to a <see cref="TZCAPI|TZ_Instance"/> stucture.</summary> |
| PTZ_Time |
TZCAPI |
<summary>A <c>Pointer</c> to a <see cref="TZCAPI|TZ_Time"/> type.</summary> |
| TBundledTimeZone |
TZDB |
<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> |
| TLocalTimeType |
TZDB |
<summary>Defines four types that a local date/time type can be in.</summary> |
| TZ_EnumProc |
TZCAPI |
<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_EnumTimeZones |
TZCAPI |
<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_GetAbbreviation |
TZCAPI |
<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_GetDisplayName |
TZCAPI |
<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_GetLocalTimeType |
TZCAPI |
<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_GetUtcOffset |
TZCAPI |
<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_InitInstance |
TZCAPI |
<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_Instance |
TZCAPI |
<summary>An opaque structure that identifies a time zone object.</summary> |
| TZ_LocalToUtc |
TZCAPI |
<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_ReleaseInstance |
TZCAPI |
<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_Result |
TZCAPI |
<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_Time |
TZCAPI |
<summary>An <c>Int64</c> representing the C/UNIX time format.</summary> |
| TZ_UtcToLocal |
TZCAPI |
<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