---
product: Chilkat
product_version: 11.7.0
language: delphidll
language_label: Delphi DLL
class: DtObj
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/dd_CkDtObjRef.html
---
# Chilkat DtObj — Delphi DLL — v11.7.0

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

## Purpose

**Represent a date/time as simple editable fields.**

`Chilkat.DtObj` is a lightweight date/time value object used by Chilkat methods that need to pass or return individual date and time fields. It stores values such as year, month, day, hour, minute, and second, along with a flag indicating whether the value represents UTC or local time. It also provides a compact serialization format for saving and restoring the date/time value.

**Simple date fields**

Store and edit the year, month, day, hour, minute, and second as individual properties.

**UTC or local time**

Use the UTC flag to indicate whether the stored fields represent UTC or local time.

**Struct tm compatibility**

Use alternate month and year properties when working with `struct tm`-style date/time conventions.

**Serialize and restore**

Save and restore the object using Chilkat's compact internal serialized date/time representation.

**Used by other classes**

Pass `DtObj` values to Chilkat methods that require explicit date/time fields or return date/time information.

**Small and focused**

Use this class as a simple container rather than a full date/time calculation or timezone-conversion engine.

**Common pattern:** Create or receive a `DtObj`, set or read the individual date/time fields, check whether the value is UTC or local time, and pass the object to another Chilkat method. Use serialization only when the date/time value needs to be saved and restored in Chilkat's compact internal format.

For an extended overview, see [DtObj Class Overview](https://www.chilkatsoft.com/dtobj_class_overview.asp).

## Object creation, unlocking and error handling

**Create/Dispose**

```pascal
var
myObject: HCkDtObj;

begin
myObject := CkDtObj_Create();

// ...

CkDtObj_Dispose(myObject);
end;
```

`function CkDtObj_Create: HCkDtObj; stdcall;`

Creates an instance of the HCkDtObj object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

`procedure CkDtObj_Dispose(handle: HCkDtObj); stdcall;`

Objects created by calling CkDtObj_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

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 Delphi DLL.

## 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` | `procedure CkDtObj_getDebugLogFilePath(objHandle: HCkDtObj; outPropVal: HCkString); stdcall; procedure CkDtObj_putDebugLogFilePath(objHandle: HCkDtObj; newPropVal: PWideChar); stdcall; function CkDtObj__debugLogFilePath(objHandle: HCkDtObj): PWideChar; stdcall;` | 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` | `procedure CkDtObj_getLastErrorHtml(objHandle: HCkDtObj; outPropVal: HCkString); stdcall; function CkDtObj__lastErrorHtml(objHandle: HCkDtObj): PWideChar; stdcall;` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `procedure CkDtObj_getLastErrorText(objHandle: HCkDtObj; outPropVal: HCkString); stdcall; function CkDtObj__lastErrorText(objHandle: HCkDtObj): PWideChar; stdcall;` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `procedure CkDtObj_getLastErrorXml(objHandle: HCkDtObj; outPropVal: HCkString); stdcall; function CkDtObj__lastErrorXml(objHandle: HCkDtObj): PWideChar; stdcall;` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `function CkDtObj_getLastMethodSuccess(objHandle: HCkDtObj): wordbool; stdcall; procedure CkDtObj_putLastMethodSuccess(objHandle: HCkDtObj; newPropVal: wordbool); stdcall;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `function CkDtObj_getVerboseLogging(objHandle: HCkDtObj): wordbool; stdcall; procedure CkDtObj_putVerboseLogging(objHandle: HCkDtObj; newPropVal: wordbool); stdcall;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `procedure CkDtObj_getVersion(objHandle: HCkDtObj; outPropVal: HCkString); stdcall; function CkDtObj__version(objHandle: HCkDtObj): PWideChar; stdcall;` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Day` | property, read/write | `function CkDtObj_getDay(objHandle: HCkDtObj): Integer; stdcall; procedure CkDtObj_putDay(objHandle: HCkDtObj; newPropVal: Integer); stdcall;` |
| `Hour` | property, read/write | `function CkDtObj_getHour(objHandle: HCkDtObj): Integer; stdcall; procedure CkDtObj_putHour(objHandle: HCkDtObj; newPropVal: Integer); stdcall;` |
| `Minute` | property, read/write | `function CkDtObj_getMinute(objHandle: HCkDtObj): Integer; stdcall; procedure CkDtObj_putMinute(objHandle: HCkDtObj; newPropVal: Integer); stdcall;` |
| `Month` | property, read/write | `function CkDtObj_getMonth(objHandle: HCkDtObj): Integer; stdcall; procedure CkDtObj_putMonth(objHandle: HCkDtObj; newPropVal: Integer); stdcall;` |
| `Second` | property, read/write | `function CkDtObj_getSecond(objHandle: HCkDtObj): Integer; stdcall; procedure CkDtObj_putSecond(objHandle: HCkDtObj; newPropVal: Integer); stdcall;` |
| `StructTmMonth` | property, read/write | `function CkDtObj_getStructTmMonth(objHandle: HCkDtObj): Integer; stdcall; procedure CkDtObj_putStructTmMonth(objHandle: HCkDtObj; newPropVal: Integer); stdcall;` |
| `StructTmYear` | property, read/write | `function CkDtObj_getStructTmYear(objHandle: HCkDtObj): Integer; stdcall; procedure CkDtObj_putStructTmYear(objHandle: HCkDtObj; newPropVal: Integer); stdcall;` |
| `Utc` | property, read/write | `function CkDtObj_getUtc(objHandle: HCkDtObj): wordbool; stdcall; procedure CkDtObj_putUtc(objHandle: HCkDtObj; newPropVal: wordbool); stdcall;` |
| `Year` | property, read/write | `function CkDtObj_getYear(objHandle: HCkDtObj): Integer; stdcall; procedure CkDtObj_putYear(objHandle: HCkDtObj; newPropVal: Integer); stdcall;` |
| `DeSerialize` | method | `procedure CkDtObj_DeSerialize(objHandle: HCkDtObj;     serializedDtObj: PWideChar) stdcall;` |
| `Serialize` | method | `function CkDtObj_Serialize(objHandle: HCkDtObj;     outStr: HCkString): wordbool; stdcall; function CkDtObj__serialize(objHandle: HCkDtObj): PWideChar; stdcall;` |

## Properties

### DtObj.Day

`Chilkat 11.7.0 · delphidll · DtObj · Day · property · read/write`

```pascal
function CkDtObj_getDay(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putDay(objHandle: HCkDtObj; newPropVal: Integer); stdcall;
```

The day of the month. The valid values for this member are 1 through 31.

### DtObj.Hour

`Chilkat 11.7.0 · delphidll · DtObj · Hour · property · read/write`

```pascal
function CkDtObj_getHour(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putHour(objHandle: HCkDtObj; newPropVal: Integer); stdcall;
```

The hour. The valid values for this member are 0 through 23.

### DtObj.Minute

`Chilkat 11.7.0 · delphidll · DtObj · Minute · property · read/write`

```pascal
function CkDtObj_getMinute(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putMinute(objHandle: HCkDtObj; newPropVal: Integer); stdcall;
```

The minute. The valid values for this member are 0 through 59.

### DtObj.Month

`Chilkat 11.7.0 · delphidll · DtObj · Month · property · read/write`

```pascal
function CkDtObj_getMonth(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putMonth(objHandle: HCkDtObj; newPropVal: Integer); stdcall;
```

The month. The valid values for this member are 1 through 12 where 1 = January and 12 = December.

### DtObj.Second

`Chilkat 11.7.0 · delphidll · DtObj · Second · property · read/write`

```pascal
function CkDtObj_getSecond(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putSecond(objHandle: HCkDtObj; newPropVal: Integer); stdcall;
```

The second. The valid values for this member are 0 through 59.

### DtObj.StructTmMonth

`Chilkat 11.7.0 · delphidll · DtObj · StructTmMonth · property · read/write`

```pascal
function CkDtObj_getStructTmMonth(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putStructTmMonth(objHandle: HCkDtObj; newPropVal: Integer); stdcall;
```

The month. The valid values for this member are 0 through 11 where 0 = January and 11 = December.

### DtObj.StructTmYear

`Chilkat 11.7.0 · delphidll · DtObj · StructTmYear · property · read/write`

```pascal
function CkDtObj_getStructTmYear(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putStructTmYear(objHandle: HCkDtObj; newPropVal: Integer); stdcall;
```

The year represented as the number of years since 1900.

### DtObj.Utc

`Chilkat 11.7.0 · delphidll · DtObj · Utc · property · read/write`

```pascal
function CkDtObj_getUtc(objHandle: HCkDtObj): wordbool; stdcall;
procedure CkDtObj_putUtc(objHandle: HCkDtObj; newPropVal: wordbool); stdcall;
```

`True` if this is a UTC time, otherwise `False` if this is a local time.

### DtObj.Year

`Chilkat 11.7.0 · delphidll · DtObj · Year · property · read/write`

```pascal
function CkDtObj_getYear(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putYear(objHandle: HCkDtObj; newPropVal: Integer); stdcall;
```

The year, such as 2012.

## Methods

### DtObj.DeSerialize

`Chilkat 11.7.0 · delphidll · DtObj · DeSerialize · method`

```pascal
procedure CkDtObj_DeSerialize(objHandle: HCkDtObj;
    serializedDtObj: PWideChar) stdcall;
```

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.

### DtObj.Serialize

`Chilkat 11.7.0 · delphidll · DtObj · Serialize · method`

```pascal
function CkDtObj_Serialize(objHandle: HCkDtObj;
    outStr: HCkString): wordbool; stdcall;
function CkDtObj__serialize(objHandle: HCkDtObj): PWideChar; stdcall;
```

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/0.

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

