---
product: Chilkat
product_version: 11.7.0
language: tcl
language_label: Tcl
class: DtObj
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/tclDtObjRef.html
---
# Chilkat DtObj — Tcl — v11.7.0

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

**Object Creation**

```tcl
# 'this' is not a keyword in Tcl. It can freely be used as a variable name.
set this [new CkDtObj]
```

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

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` | `string # ckStr is a CkString CkDtObj_get_DebugLogFilePath $this $ckStr set strVal [CkDtObj_get_debugLogFilePath $this] CkDtObj_put_DebugLogFilePath $this $strVal` | 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` | `string # ckStr is a CkString CkDtObj_get_LastErrorHtml $this $ckStr set strVal [CkDtObj_get_lastErrorHtml $this]` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string # ckStr is a CkString CkDtObj_get_LastErrorText $this $ckStr set strVal [CkDtObj_get_lastErrorText $this]` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string # ckStr is a CkString CkDtObj_get_LastErrorXml $this $ckStr set strVal [CkDtObj_get_lastErrorXml $this]` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `boolean 1/0 set boolVal [CkDtObj_get_LastMethodSuccess $this] CkDtObj_put_LastMethodSuccess $this $boolVal` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `Utf8` | `boolean 1/0 set boolVal [CkDtObj_get_Utf8 $this] CkDtObj_put_Utf8 $this $boolVal` | read/write | When set to `1`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `boolean 1/0 set boolVal [CkDtObj_get_VerboseLogging $this] CkDtObj_put_VerboseLogging $this $boolVal` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string # ckStr is a CkString CkDtObj_get_Version $this $ckStr set strVal [CkDtObj_get_version $this]` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Day` | property, read/write | `integer set intVal [CkDtObj_get_Day $this] CkDtObj_put_Day $this $intVal` |
| `Hour` | property, read/write | `integer set intVal [CkDtObj_get_Hour $this] CkDtObj_put_Hour $this $intVal` |
| `Minute` | property, read/write | `integer set intVal [CkDtObj_get_Minute $this] CkDtObj_put_Minute $this $intVal` |
| `Month` | property, read/write | `integer set intVal [CkDtObj_get_Month $this] CkDtObj_put_Month $this $intVal` |
| `Second` | property, read/write | `integer set intVal [CkDtObj_get_Second $this] CkDtObj_put_Second $this $intVal` |
| `StructTmMonth` | property, read/write | `integer set intVal [CkDtObj_get_StructTmMonth $this] CkDtObj_put_StructTmMonth $this $intVal` |
| `StructTmYear` | property, read/write | `integer set intVal [CkDtObj_get_StructTmYear $this] CkDtObj_put_StructTmYear $this $intVal` |
| `Utc` | property, read/write | `boolean 1/0 set boolVal [CkDtObj_get_Utc $this] CkDtObj_put_Utc $this $boolVal` |
| `Year` | property, read/write | `integer set intVal [CkDtObj_get_Year $this] CkDtObj_put_Year $this $intVal` |
| `DeSerialize` | method | `# serializedDtObj is a string CkDtObj_DeSerialize $this $serializedDtObj` |
| `Serialize` | method | `# outStr is a CkString (output) set status [CkDtObj_Serialize $this $outStr] set retStr [CkDtObj_serialize $this]` |

## Properties

### DtObj.Day

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

```tcl
integer
set intVal [CkDtObj_get_Day $this]

CkDtObj_put_Day $this $intVal
```

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

### DtObj.Hour

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

```tcl
integer
set intVal [CkDtObj_get_Hour $this]

CkDtObj_put_Hour $this $intVal
```

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

### DtObj.Minute

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

```tcl
integer
set intVal [CkDtObj_get_Minute $this]

CkDtObj_put_Minute $this $intVal
```

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

### DtObj.Month

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

```tcl
integer
set intVal [CkDtObj_get_Month $this]

CkDtObj_put_Month $this $intVal
```

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

### DtObj.Second

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

```tcl
integer
set intVal [CkDtObj_get_Second $this]

CkDtObj_put_Second $this $intVal
```

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

### DtObj.StructTmMonth

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

```tcl
integer
set intVal [CkDtObj_get_StructTmMonth $this]

CkDtObj_put_StructTmMonth $this $intVal
```

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

### DtObj.StructTmYear

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

```tcl
integer
set intVal [CkDtObj_get_StructTmYear $this]

CkDtObj_put_StructTmYear $this $intVal
```

The year represented as the number of years since 1900.

### DtObj.Utc

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

```tcl
boolean 1/0
set boolVal [CkDtObj_get_Utc $this]

CkDtObj_put_Utc $this $boolVal
```

`1` if this is a UTC time, otherwise `0` if this is a local time.

### DtObj.Year

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

```tcl
integer
set intVal [CkDtObj_get_Year $this]

CkDtObj_put_Year $this $intVal
```

The year, such as 2012.

## Methods

### DtObj.DeSerialize

`Chilkat 11.7.0 · tcl · DtObj · DeSerialize · method`

```tcl
# serializedDtObj is a string

CkDtObj_DeSerialize $this $serializedDtObj
```

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 · tcl · DtObj · Serialize · method`

```tcl
# outStr is a CkString (output)

set status [CkDtObj_Serialize $this $outStr]

set retStr [CkDtObj_serialize $this]
```

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

