CkDateTime AutoIt Reference Documentation

CkDateTime

Current Version: 11.6.0

CkDateTime represents a date/time value and provides conversion methods for common date/time formats, including .NET DateTime, DateTime ticks, RFC 822, RFC 3339 / ISO 8601-style timestamps, Unix time, DOS date/time, OLE DATE, NTP time, ULID timestamps, and Chilkat DtObj. It also supports date arithmetic, age/expiration checks, serialization, and local/UTC conversion.

For an extended overview, see CkDateTime Class Overview

Object Creation

Local $oCkDateTime = ObjCreate("Chilkat.CkDateTime")

Register the 32-bit or 64-bit Chilkat ActiveX to match the AutoIt interpreter running the script (AutoIt3.exe or AutoIt3_x64.exe). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as ObjCreate("Chilkat.CkDateTime.11") for Chilkat v11.*.*.

Boolean properties and arguments are integers in the ActiveX (1 or 0); AutoIt's True and False convert to them automatically. A method that fails to return an object returns Null. Methods and properties that pass or return raw byte arrays are not shown on this page; use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead.

Properties

DebugLogFilePath

DebugLogFilePath ; String

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

IsDst

IsDst ; Integer (read-only)

This is the Daylight Saving Time flag. It can have one of three possible values: 1, 0, or -1. It has the value 1 if Daylight Saving Time is in effect, 0 if Daylight Saving Time is not in effect, and -1 if the information is not available.

Note: This is NOT the DST for the current system time. It is the DST that was in effect at the date value contained in this object.

LastErrorHtml

LastErrorHtml ; String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

LastErrorText ; String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml ; String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

LastMethodSuccess ; Boolean

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

LastStringResult

LastStringResult ; String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

LastStringResultLen ; Integer (read-only)

The length, in characters, of the string contained in the LastStringResult property.

UtcOffset

UtcOffset ; Integer (read-only)

For the current system's timezone, returns the number of seconds offset from UTC for this date/time. The offset includes daylight savings adjustment. Local timezones west of UTC return a negative offset.

VerboseLogging

VerboseLogging ; Boolean

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

Version ; String (read-only)

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddDays

AddDays($iNumDays) ; returns Boolean

Adds an integer number of days to the date/time. To subtract days, pass a negative integer.

Returns True for success, False for failure.

AddSeconds

AddSeconds($iNumSeconds) ; returns Boolean

Introduced in version 9.5.0.65

Adds an integer number of seconds to the date/time. To subtract seconds, pass a negative integer.

Returns True for success, False for failure.

More Information and Examples

DateTime - Add or Subtract Seconds

DeSerialize

DeSerialize($sSerializedDateTime)

Loads the date/time with a string having the format as produced by the Serialize method, which is a string of SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.

DiffSeconds

DiffSeconds($oDateTimeArg) ; returns Integer

Introduced in version 9.5.0.65

Returns the difference in seconds between the dateTimeArg and this date/time. The value returned is this object's date/time - dateTimeArg's date/time. For example, if the returned value is positive, then this object's date/time is more recent than dateTimeArg's date/time. If the return value is negative, then this object's date/time is older than dateTimeArg's date/time.

More Information and Examples

Compute Difference Between Two DateTime Strings

ExpiresWithin

ExpiresWithin($iN, $sUnits) ; returns Boolean

Introduced in version 9.5.0.67

Returns True if the date/time is within n seconds/minutes/hours/days of the current system date/time. Otherwise returns False. The units can be seconds, minutes, hours, or days (plural or singular).

More Information and Examples

Date/Time Expires Within N Seconds/Minutes/Hours/Days

GetAsDateTime

GetAsDateTime($bLocal) ; returns Date

Returns the date/time in a native format. The .NET implementation returns a .NET System.DateTime structure. The ActiveX implementation returns a Date object.

bLocal indicates whether a local or UTC time is returned.

GetAsDosDate

GetAsDosDate($bLocal) ; returns Integer

Returns the date/time as a 32-bit DOS date/time bitmask.

bLocal indicates whether a local or UTC time is returned.

The DOS date/time format is a bitmask:


			   24                16                 8                 0
	    +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
	    |Y|Y|Y|Y|Y|Y|Y|M| |M|M|M|D|D|D|D|D| |h|h|h|h|h|m|m|m| |m|m|m|s|s|s|s|s|
	    +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
	     \___________/\________/\_________/ \________/\____________/\_________/
		 year        month       day      hour       minute        second

The year is stored as an offset from 1980. Seconds are stored in two-second increments. (So if the second value is 15, it actually represents 30 seconds.)

GetAsIso8601

GetAsIso8601($sFormatStr, $bLocal) ; returns String

Introduced in version 9.5.0.65

Returns the date/time in a compatible ISO 8601 format according to the format specified in formatStr.. Examples of ISO 8601 formats include the following:

    YYYY-MM-DD

    YYYY-MM-DDThh:mmTZD

    YYYY-MM-DDThh:mm:ssTZD

    YYYY-MM-DDThh:mm:ss:sssTZD

For the date portion of these formats, YYYY is a four-digit year representation, MM is a two-digit month, and DD is a two-digit day. For the time portion, hh is the hour in 24-hour notation, mm is the two-digit minutes, ss is the two-digit seconds, and sss is the 3-digit milliseconds. A time designator T separates the date and time portions of the string, while a time zone designator TZD specifies a time zone (UTC).

bLocal indicates whether a local or UTC time is returned.

Returns Null on failure

More Information and Examples

DateTime - Get in ISO 8601 Compatible Format

GetAsOleDate

GetAsOleDate($bLocal) ; returns Double

Returns the date/time in a Windows OLE DATE format.

bLocal indicates whether a local or UTC time is returned.

The OLE automation date format is a floating point value, counting days since midnight 30 December 1899. Hours and minutes are represented as fractional days.

GetAsRfc822

GetAsRfc822($bLocal) ; returns String

Returns the date/time as an RFC822 formatted string. (An RFC822 format string is what is found in the Date header field of an email, such as Wed, 18 Oct 2017 09:08:21 GMT.)

bLocal indicates whether a local or UTC time is returned.

Returns Null on failure

GetAsTimestamp

GetAsTimestamp($bLocal) ; returns String

Introduced in version 9.5.0.58

Returns the date/time as an RFC 3339 formatted string, such as 1990-12-31T23:59:60Z. (This is an ISO 8061 format like the following: YYYY-MM-DDThh:mm:ssTZD)

bLocal indicates whether a local or UTC time is returned.

Returns Null on failure

More Information and Examples

Get Current Date/Time as Timestamp (YYYY-MM-DDThh:mm:ssTZD)

GetAsUnixTime

GetAsUnixTime($bLocal) ; returns Integer

Returns the date/time as a Unix time value, which is the number of seconds elapsed since 00:00:00 UTC on January 1, 1970.

bLocal indicates whether the date/time returned is local or UTC.

GetAsUnixTimeStr

GetAsUnixTimeStr($bLocal) ; returns String

Introduced in version 9.5.0.65

Returns the time in Unix format (in seconds since the epoch: 00:00:00 UTC on 1 January 1970).

bLocal indicates whether the date/time returned is local or UTC.

Returns Null on failure

More Information and Examples

DateTime - Get as Unix Time String

LoadTaskResult

LoadTaskResult($oTask) ; returns Boolean

Introduced in version 9.5.0.52

Loads the date/time from a completed asynchronous task.

Returns True for success, False for failure.

OlderThan

OlderThan($iN, $sUnits) ; returns Boolean

Introduced in version 9.5.0.67

Returns True if the date/time is older than the current system date/time by n seconds/minutes/hours/days. Otherwise returns False. The units can be seconds, minutes, hours, or days (plural or singular).

More Information and Examples

Date/Time Older-Than N Seconds/Minutes/Hours/Days

Serialize

Serialize() ; returns String

Serializes the date/time to a us-ascii string that can be imported at a later time via the DeSerialize method. The format of the string returned by this method is not intended to match any published standard. It is formatted to a string with SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1 or 0.

Returns Null on failure

SetFromCurrentSystemTime

SetFromCurrentSystemTime() ; returns Boolean

Sets the date/time from the current system time.

SetFromDosDate

SetFromDosDate($bLocal, $iT) ; returns Boolean

Sets the date/time from a 32-bit DOS date/time bitmask. See GetAsDosDate for more information.

SetFromDtObj

SetFromDtObj($oDt) ; returns Boolean

Introduced in version 9.5.0.47

Sets the date/time from a Chilkat Dt object.

Returns True for success, False for failure.

SetFromNtpServer

SetFromNtpServer($sJsonStr) ; returns Boolean

Introduced in version 9.5.0.96

Sets the date/time by sending a query to an NTP server.

Returns True for success, False for failure.

More Information and Examples

Query NTP Server for Current Date/Time

SetFromNtpTime

SetFromNtpTime($iNtpSeconds) ; returns Boolean

Introduced in version 9.5.0.50

Sets the date/time from a 32-bit NTP time value. ntpSeconds is the number of seconds since 00:00 (midnight) 1 January 1900 GMT.

SetFromOleDate

SetFromOleDate($bLocal, $nDt) ; returns Boolean

Sets the date/time from a Windows OLE DATE value.

bLocal indicates whether the passed in date/time is local or UTC.

Note: This method was not working correctly. The problem was discovered just after releasing v9.5.0.65. It will be fixed in the next version update.

SetFromRfc822

SetFromRfc822($sRfc822Str) ; returns Boolean

Sets the date/time from an RFC822 date/time formatted string. Here are some examples of RFC822 formatted date/times:

Tue, 15 Nov 2022 22:00:58 +0000
Tue, 15 Nov 2022 20:21:50 +0100
Tue, 01 Nov 2022 18:09:41 -0600

Returns True for success, False for failure.

SetFromTimestamp

SetFromTimestamp($sTimestamp) ; returns Boolean

Introduced in version 9.5.0.58

Sets the date/time from an RFC 3339 timestamp format. (such as 1990-12-31T23:59:60Z:)

(This is an ISO 8061 format like the following: YYYY-MM-DDThh:mm:ssTZD)

Note: Starting in v9.5.0.77, strings formatted as YYMMDDhhmmssZ, such as 181221132225Z, can also be passed to this method.

Returns True for success, False for failure.

More Information and Examples

How to Parse a TimeStamp (such as 2016-11-11T14:32:17.0908971Z)

SetFromUlid

SetFromUlid($bLocal, $sUlid) ; returns Boolean

Introduced in version 9.5.0.94

Sets this object's date/time using the timestamp embedded in the ulid. If the ulid was not a valid ULID, returns False and the date/time is not set. bLocal indicates whether the ulid uses a local time or UTC time.

Returns True for success, False for failure.

More Information and Examples

Extract Timestamp from ULID

SetFromUnixTime

SetFromUnixTime($bLocal, $iT) ; returns Boolean

Sets the date/time from a UNIX time value.

bLocal indicates whether the passed in date/time is local or UTC.

ToDtObj

ToDtObj($bLocal, $oDtObj)

Introduced in version 11.0.0

Copies the date/time to the dtObj. Gets the date/time in the local time if bLocal is True, or GMT if bLocal is False.

UlidGenerate

UlidGenerate($bLocal) ; returns String

Introduced in version 9.5.0.94

Generates and returns a new ULID using this object's date/time value. bLocal indicates whether to use local time or UTC time.

Returns Null on failure

More Information and Examples

UlidIncrement

UlidIncrement($oUlid) ; returns Boolean

Introduced in version 9.5.0.94

Increments the ULID that is passed in ulid.

More Information and Examples

Generate Monotonic ULIDs

UlidValidate

UlidValidate($sUlid) ; returns Boolean

Introduced in version 9.5.0.94

Validates the ulid. Returns True if the ulid is valid, otherwise returns False.

Returns True for success, False for failure.

More Information and Examples

Validate a ULID

Deprecated

GetDtObj

GetDtObj($bLocal) ; returns DtObj object

Introduced in version 9.5.0.47

This method is deprecated.

Returns that date/time in the date-time object.

This method is deprecated and will be removed in a future version. Applications should use the ToDtObj method.

Returns Null on failure

More Information and Examples

Get Email Date/Time