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

> Chilkat 11.7.0 · language=foxpro · 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/foxpro/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**

```foxpro
loCkDateTime = CreateObject('Chilkat.CkDateTime')
```

Visual FoxPro is a 32-bit application and therefore uses the 32-bit Chilkat ActiveX. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `CreateObject('Chilkat.CkDateTime.11')` for Chilkat v11.\*.\*.

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

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 As 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. |
| `LastBinaryResult` | `LastBinaryResult As Variant (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Number` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `LastStringResult As 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 As Number (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `VerboseLogging As Number` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As 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 As Number (read-only)` |
| `UtcOffset` | property, read-only | `UtcOffset As Number (read-only)` |
| `AddDays` | method | `AddDays(numDays As Number) As Number` |
| `AddSeconds` | method | `AddSeconds(numSeconds As Number) As Number` |
| `DeSerialize` | method | `DeSerialize(serializedDateTime As String)` |
| `DiffSeconds` | method | `DiffSeconds(dateTimeArg As CkDateTime) As Number` |
| `ExpiresWithin` | method | `ExpiresWithin(n As Number, units As String) As Number` |
| `GetAsDateTime` | method | `GetAsDateTime(bLocal As Number) As DateTime` |
| `GetAsDosDate` | method | `GetAsDosDate(bLocal As Number) As Number` |
| `GetAsIso8601` | method | `GetAsIso8601(formatStr As String, bLocal As Number) As String` |
| `GetAsOleDate` | method | `GetAsOleDate(bLocal As Number) As Number` |
| `GetAsRfc822` | method | `GetAsRfc822(bLocal As Number) As String` |
| `GetAsTimestamp` | method | `GetAsTimestamp(bLocal As Number) As String` |
| `GetAsUnixTime` | method | `GetAsUnixTime(bLocal As Number) As Number` |
| `GetAsUnixTimeStr` | method | `GetAsUnixTimeStr(bLocal As Number) As String` |
| `LoadTaskResult` | method | `LoadTaskResult(task As ChilkatTask) As Number` |
| `OlderThan` | method | `OlderThan(n As Number, units As String) As Number` |
| `Serialize` | method | `Serialize() As String` |
| `SetFromCurrentSystemTime` | method | `SetFromCurrentSystemTime() As Number` |
| `SetFromDosDate` | method | `SetFromDosDate(bLocal As Number, t As Number) As Number` |
| `SetFromDtObj` | method | `SetFromDtObj(dt As DtObj) As Number` |
| `SetFromNtpServer` | method | `SetFromNtpServer(jsonStr As String) As Number` |
| `SetFromNtpTime` | method | `SetFromNtpTime(ntpSeconds As Number) As Number` |
| `SetFromOleDate` | method | `SetFromOleDate(bLocal As Number, dt As Number) As Number` |
| `SetFromRfc822` | method | `SetFromRfc822(rfc822Str As String) As Number` |
| `SetFromTimestamp` | method | `SetFromTimestamp(timestamp As String) As Number` |
| `SetFromUlid` | method | `SetFromUlid(bLocal As Number, ulid As String) As Number` |
| `SetFromUnixTime` | method | `SetFromUnixTime(bLocal As Number, t As Number) As Number` |
| `ToDtObj` | method | `ToDtObj(bLocal As Number, dtObj As DtObj)` |
| `UlidGenerate` | method | `UlidGenerate(bLocal As Number) As String` |
| `UlidIncrement` | method | `UlidIncrement(ulid As ChilkatStringBuilder) As Number` |
| `UlidValidate` | method | `UlidValidate(ulid As String) As Number` |

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 · foxpro · CkDateTime · IsDst · property · read-only`

```foxpro
IsDst As Number (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 · foxpro · CkDateTime · UtcOffset · property · read-only`

```foxpro
UtcOffset As Number (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 · foxpro · CkDateTime · AddDays · method`

```foxpro
AddDays(numDays As Number) As Number
```

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

Returns 1 for success, 0 for failure.

### CkDateTime.AddSeconds

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

```foxpro
AddSeconds(numSeconds As Number) As Number
```

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

Returns 1 for success, 0 for failure.

### CkDateTime.DeSerialize

`Chilkat 11.7.0 · foxpro · CkDateTime · DeSerialize · method`

```foxpro
DeSerialize(serializedDateTime As String)
```

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 · foxpro · CkDateTime · DiffSeconds · method · since 9.5.0.65`

```foxpro
DiffSeconds(dateTimeArg As CkDateTime) As Number
```

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 · foxpro · CkDateTime · ExpiresWithin · method · since 9.5.0.67`

```foxpro
ExpiresWithin(n As Number, units As String) As Number
```

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

### CkDateTime.GetAsDateTime

`Chilkat 11.7.0 · foxpro · CkDateTime · GetAsDateTime · method`

```foxpro
GetAsDateTime(bLocal As Number) As DateTime
```

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 · foxpro · CkDateTime · GetAsDosDate · method`

```foxpro
GetAsDosDate(bLocal As Number) As Number
```

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 · foxpro · CkDateTime · GetAsIso8601 · method · since 9.5.0.65`

```foxpro
GetAsIso8601(formatStr As String, bLocal As Number) As 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 · foxpro · CkDateTime · GetAsOleDate · method`

```foxpro
GetAsOleDate(bLocal As Number) As Number
```

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 · foxpro · CkDateTime · GetAsRfc822 · method`

```foxpro
GetAsRfc822(bLocal As Number) As 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 · foxpro · CkDateTime · GetAsTimestamp · method · since 9.5.0.58`

```foxpro
GetAsTimestamp(bLocal As Number) As 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 · foxpro · CkDateTime · GetAsUnixTime · method`

```foxpro
GetAsUnixTime(bLocal As Number) As Number
```

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 · foxpro · CkDateTime · GetAsUnixTimeStr · method · since 9.5.0.65`

```foxpro
GetAsUnixTimeStr(bLocal As Number) As 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 · foxpro · CkDateTime · LoadTaskResult · method · since 9.5.0.52`

```foxpro
LoadTaskResult(task As ChilkatTask) As Number
```

Loads the date/time from a completed asynchronous task.

Returns 1 for success, 0 for failure.

### CkDateTime.OlderThan

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

```foxpro
OlderThan(n As Number, units As String) As Number
```

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

### CkDateTime.Serialize

`Chilkat 11.7.0 · foxpro · CkDateTime · Serialize · method`

```foxpro
Serialize() As 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 · foxpro · CkDateTime · SetFromCurrentSystemTime · method`

```foxpro
SetFromCurrentSystemTime() As Number
```

Sets the date/time from the current system time.

Returns 1 for success, 0 for failure.

### CkDateTime.SetFromDosDate

`Chilkat 11.7.0 · foxpro · CkDateTime · SetFromDosDate · method`

```foxpro
SetFromDosDate(bLocal As Number, t As Number) As Number
```

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

Returns 1 for success, 0 for failure.

### CkDateTime.SetFromDtObj

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

```foxpro
SetFromDtObj(dt As DtObj) As Number
```

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

Returns 1 for success, 0 for failure.

### CkDateTime.SetFromNtpServer

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

```foxpro
SetFromNtpServer(jsonStr As String) As Number
```

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

Returns 1 for success, 0 for failure.

### CkDateTime.SetFromNtpTime

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

```foxpro
SetFromNtpTime(ntpSeconds As Number) As Number
```

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 1 for success, 0 for failure.

### CkDateTime.SetFromOleDate

`Chilkat 11.7.0 · foxpro · CkDateTime · SetFromOleDate · method`

```foxpro
SetFromOleDate(bLocal As Number, dt As Number) As Number
```

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 1 for success, 0 for failure.

### CkDateTime.SetFromRfc822

`Chilkat 11.7.0 · foxpro · CkDateTime · SetFromRfc822 · method`

```foxpro
SetFromRfc822(rfc822Str As String) As Number
```

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 1 for success, 0 for failure.

### CkDateTime.SetFromTimestamp

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

```foxpro
SetFromTimestamp(timestamp As String) As Number
```

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 1 for success, 0 for failure.

### CkDateTime.SetFromUlid

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

```foxpro
SetFromUlid(bLocal As Number, ulid As String) As Number
```

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

Returns 1 for success, 0 for failure.

### CkDateTime.SetFromUnixTime

`Chilkat 11.7.0 · foxpro · CkDateTime · SetFromUnixTime · method`

```foxpro
SetFromUnixTime(bLocal As Number, t As Number) As Number
```

Sets the date/time from a UNIX time value.

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

Returns 1 for success, 0 for failure.

### CkDateTime.ToDtObj

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

```foxpro
ToDtObj(bLocal As Number, dtObj As DtObj)
```

Copies the date/time to the `dtObj`. Gets the date/time in the local time if `bLocal` is `1`, or GMT if `bLocal` is `0`.

### CkDateTime.UlidGenerate

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

```foxpro
UlidGenerate(bLocal As Number) As 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 · foxpro · CkDateTime · UlidIncrement · method · since 9.5.0.94`

```foxpro
UlidIncrement(ulid As ChilkatStringBuilder) As Number
```

Increments the ULID that is passed in `ulid`.

Returns 1 for success, 0 for failure.

### CkDateTime.UlidValidate

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

```foxpro
UlidValidate(ulid As String) As Number
```

Validates the `ulid`. Returns `1` if the `ulid` is valid, otherwise returns `0`.

Returns 1 for success, 0 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/foxpro/classes/DtObj.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/foxpro/classes/Task.md)

