---
product: Chilkat
product_version: 11.7.0
language: autoit
language_label: AutoIt
class: CkDateTime
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/autoit_CkDateTimeRef.html
---
# Chilkat CkDateTime — AutoIt — v11.7.0

> Chilkat 11.7.0 · language=autoit · class=CkDateTime
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/CkDateTime.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/autoit/guide.md`.

## Purpose

`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](https://www.chilkatsoft.com/ckdatetime_class_overview.asp)

## Object creation, unlocking and error handling

**Object Creation**

```autoit
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.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in AutoIt.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath ; String` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `LastErrorHtml ; String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText ; String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml ; String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess ; Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `LastStringResult` | `LastStringResult ; String (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `LastStringResultLen ; Integer (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `VerboseLogging ; Boolean` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version ; String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `IsDst` | property, read-only | `IsDst ; Integer (read-only)` |
| `UtcOffset` | property, read-only | `UtcOffset ; Integer (read-only)` |
| `AddDays` | method | `AddDays($iNumDays) ; returns Boolean` |
| `AddSeconds` | method | `AddSeconds($iNumSeconds) ; returns Boolean` |
| `DeSerialize` | method | `DeSerialize($sSerializedDateTime)` |
| `DiffSeconds` | method | `DiffSeconds($oDateTimeArg) ; returns Integer` |
| `ExpiresWithin` | method | `ExpiresWithin($iN, $sUnits) ; returns Boolean` |
| `GetAsDateTime` | method | `GetAsDateTime($bLocal) ; returns Date` |
| `GetAsDosDate` | method | `GetAsDosDate($bLocal) ; returns Integer` |
| `GetAsIso8601` | method | `GetAsIso8601($sFormatStr, $bLocal) ; returns String` |
| `GetAsOleDate` | method | `GetAsOleDate($bLocal) ; returns Double` |
| `GetAsRfc822` | method | `GetAsRfc822($bLocal) ; returns String` |
| `GetAsTimestamp` | method | `GetAsTimestamp($bLocal) ; returns String` |
| `GetAsUnixTime` | method | `GetAsUnixTime($bLocal) ; returns Integer` |
| `GetAsUnixTimeStr` | method | `GetAsUnixTimeStr($bLocal) ; returns String` |
| `LoadTaskResult` | method | `LoadTaskResult($oTask) ; returns Boolean` |
| `OlderThan` | method | `OlderThan($iN, $sUnits) ; returns Boolean` |
| `Serialize` | method | `Serialize() ; returns String` |
| `SetFromCurrentSystemTime` | method | `SetFromCurrentSystemTime() ; returns Boolean` |
| `SetFromDosDate` | method | `SetFromDosDate($bLocal, $iT) ; returns Boolean` |
| `SetFromDtObj` | method | `SetFromDtObj($oDt) ; returns Boolean` |
| `SetFromNtpServer` | method | `SetFromNtpServer($sJsonStr) ; returns Boolean` |
| `SetFromNtpTime` | method | `SetFromNtpTime($iNtpSeconds) ; returns Boolean` |
| `SetFromOleDate` | method | `SetFromOleDate($bLocal, $nDt) ; returns Boolean` |
| `SetFromRfc822` | method | `SetFromRfc822($sRfc822Str) ; returns Boolean` |
| `SetFromTimestamp` | method | `SetFromTimestamp($sTimestamp) ; returns Boolean` |
| `SetFromUlid` | method | `SetFromUlid($bLocal, $sUlid) ; returns Boolean` |
| `SetFromUnixTime` | method | `SetFromUnixTime($bLocal, $iT) ; returns Boolean` |
| `ToDtObj` | method | `ToDtObj($bLocal, $oDtObj)` |
| `UlidGenerate` | method | `UlidGenerate($bLocal) ; returns String` |
| `UlidIncrement` | method | `UlidIncrement($oUlid) ; returns Boolean` |
| `UlidValidate` | method | `UlidValidate($sUlid) ; returns Boolean` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### CkDateTime.IsDst

`Chilkat 11.7.0 · autoit · CkDateTime · IsDst · property · read-only`

```autoit
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.

### CkDateTime.UtcOffset

`Chilkat 11.7.0 · autoit · CkDateTime · UtcOffset · property · read-only`

```autoit
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.

## Methods

### CkDateTime.AddDays

`Chilkat 11.7.0 · autoit · CkDateTime · AddDays · method`

```autoit
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.

### CkDateTime.AddSeconds

`Chilkat 11.7.0 · autoit · CkDateTime · AddSeconds · method · since 9.5.0.65`

```autoit
AddSeconds($iNumSeconds)  ; returns Boolean
```

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

Returns True for success, False for failure.

### CkDateTime.DeSerialize

`Chilkat 11.7.0 · autoit · CkDateTime · DeSerialize · method`

```autoit
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.

### CkDateTime.DiffSeconds

`Chilkat 11.7.0 · autoit · CkDateTime · DiffSeconds · method · since 9.5.0.65`

```autoit
DiffSeconds($oDateTimeArg)  ; returns Integer
```

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.

### CkDateTime.ExpiresWithin

`Chilkat 11.7.0 · autoit · CkDateTime · ExpiresWithin · method · since 9.5.0.67`

```autoit
ExpiresWithin($iN, $sUnits)  ; returns Boolean
```

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).

### CkDateTime.GetAsDateTime

`Chilkat 11.7.0 · autoit · CkDateTime · GetAsDateTime · method`

```autoit
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.

### CkDateTime.GetAsDosDate

`Chilkat 11.7.0 · autoit · CkDateTime · GetAsDosDate · method`

```autoit
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.)

### CkDateTime.GetAsIso8601

`Chilkat 11.7.0 · autoit · CkDateTime · GetAsIso8601 · method · since 9.5.0.65`

```autoit
GetAsIso8601($sFormatStr, $bLocal)  ; returns String
```

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

### CkDateTime.GetAsOleDate

`Chilkat 11.7.0 · autoit · CkDateTime · GetAsOleDate · method`

```autoit
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.

### CkDateTime.GetAsRfc822

`Chilkat 11.7.0 · autoit · CkDateTime · GetAsRfc822 · method`

```autoit
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

### CkDateTime.GetAsTimestamp

`Chilkat 11.7.0 · autoit · CkDateTime · GetAsTimestamp · method · since 9.5.0.58`

```autoit
GetAsTimestamp($bLocal)  ; returns String
```

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

### CkDateTime.GetAsUnixTime

`Chilkat 11.7.0 · autoit · CkDateTime · GetAsUnixTime · method`

```autoit
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.

### CkDateTime.GetAsUnixTimeStr

`Chilkat 11.7.0 · autoit · CkDateTime · GetAsUnixTimeStr · method · since 9.5.0.65`

```autoit
GetAsUnixTimeStr($bLocal)  ; returns String
```

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

### CkDateTime.LoadTaskResult

`Chilkat 11.7.0 · autoit · CkDateTime · LoadTaskResult · method · since 9.5.0.52`

```autoit
LoadTaskResult($oTask)  ; returns Boolean
```

Loads the date/time from a completed asynchronous task.

Returns True for success, False for failure.

### CkDateTime.OlderThan

`Chilkat 11.7.0 · autoit · CkDateTime · OlderThan · method · since 9.5.0.67`

```autoit
OlderThan($iN, $sUnits)  ; returns Boolean
```

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).

### CkDateTime.Serialize

`Chilkat 11.7.0 · autoit · CkDateTime · Serialize · method`

```autoit
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

### CkDateTime.SetFromCurrentSystemTime

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromCurrentSystemTime · method`

```autoit
SetFromCurrentSystemTime()  ; returns Boolean
```

Sets the date/time from the current system time.

Returns True for success, False for failure.

### CkDateTime.SetFromDosDate

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromDosDate · method`

```autoit
SetFromDosDate($bLocal, $iT)  ; returns Boolean
```

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

Returns True for success, False for failure.

### CkDateTime.SetFromDtObj

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromDtObj · method · since 9.5.0.47`

```autoit
SetFromDtObj($oDt)  ; returns Boolean
```

Sets the date/time from a Chilkat `Dt` object.

Returns True for success, False for failure.

### CkDateTime.SetFromNtpServer

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromNtpServer · method · since 9.5.0.96`

```autoit
SetFromNtpServer($sJsonStr)  ; returns Boolean
```

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

Returns True for success, False for failure.

### CkDateTime.SetFromNtpTime

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromNtpTime · method · since 9.5.0.50`

```autoit
SetFromNtpTime($iNtpSeconds)  ; returns Boolean
```

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.

Returns True for success, False for failure.

### CkDateTime.SetFromOleDate

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromOleDate · method`

```autoit
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.

Returns True for success, False for failure.

### CkDateTime.SetFromRfc822

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromRfc822 · method`

```autoit
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.

### CkDateTime.SetFromTimestamp

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromTimestamp · method · since 9.5.0.58`

```autoit
SetFromTimestamp($sTimestamp)  ; returns Boolean
```

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.

### CkDateTime.SetFromUlid

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromUlid · method · since 9.5.0.94`

```autoit
SetFromUlid($bLocal, $sUlid)  ; returns Boolean
```

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.

### CkDateTime.SetFromUnixTime

`Chilkat 11.7.0 · autoit · CkDateTime · SetFromUnixTime · method`

```autoit
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.

Returns True for success, False for failure.

### CkDateTime.ToDtObj

`Chilkat 11.7.0 · autoit · CkDateTime · ToDtObj · method · since 11.0.0`

```autoit
ToDtObj($bLocal, $oDtObj)
```

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`.

### CkDateTime.UlidGenerate

`Chilkat 11.7.0 · autoit · CkDateTime · UlidGenerate · method · since 9.5.0.94`

```autoit
UlidGenerate($bLocal)  ; returns String
```

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

### CkDateTime.UlidIncrement

`Chilkat 11.7.0 · autoit · CkDateTime · UlidIncrement · method · since 9.5.0.94`

```autoit
UlidIncrement($oUlid)  ; returns Boolean
```

Increments the ULID that is passed in `ulid`.

Returns True for success, False for failure.

### CkDateTime.UlidValidate

`Chilkat 11.7.0 · autoit · CkDateTime · UlidValidate · method · since 9.5.0.94`

```autoit
UlidValidate($sUlid)  ; returns Boolean
```

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

Returns True for success, False for failure.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `GetDtObj` | method | before 11.6.1 | — |

## Related classes

[`DtObj`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/autoit/classes/DtObj.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/autoit/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/autoit/classes/Task.md)

