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

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

```c
HCkDtObj instance = CkDtObj_Create();
// ...
CkDtObj_Dispose(instance);
```

`HCkDtObj CkDtObj_Create(void);`

Creates an instance of the HCkDtObj object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page.

`void CkDtObj_Dispose(HCkDtObj handle);`

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkDtObj_Dispose.

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

## 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` | `void CkDtObj_getDebugLogFilePath(HCkDtObj cHandle, HCkString retval); void CkDtObj_putDebugLogFilePath(HCkDtObj cHandle, const char *newVal); const char *CkDtObj_debugLogFilePath(HCkDtObj cHandle);` | 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` | `void CkDtObj_getLastErrorHtml(HCkDtObj cHandle, HCkString retval); const char *CkDtObj_lastErrorHtml(HCkDtObj cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkDtObj_getLastErrorText(HCkDtObj cHandle, HCkString retval); const char *CkDtObj_lastErrorText(HCkDtObj cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkDtObj_getLastErrorXml(HCkDtObj cHandle, HCkString retval); const char *CkDtObj_lastErrorXml(HCkDtObj cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkDtObj_getLastMethodSuccess(HCkDtObj cHandle); void CkDtObj_putLastMethodSuccess(HCkDtObj cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `Utf8` | `BOOL CkDtObj_getUtf8(HCkDtObj cHandle); void CkDtObj_putUtf8(HCkDtObj cHandle, BOOL newVal);` | read/write | When set to `TRUE`, all `const char *` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `BOOL CkDtObj_getVerboseLogging(HCkDtObj cHandle); void CkDtObj_putVerboseLogging(HCkDtObj cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkDtObj_getVersion(HCkDtObj cHandle, HCkString retval); const char *CkDtObj_version(HCkDtObj cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Day` | property, read/write | `int CkDtObj_getDay(HCkDtObj cHandle); void CkDtObj_putDay(HCkDtObj cHandle, int newVal);` |
| `Hour` | property, read/write | `int CkDtObj_getHour(HCkDtObj cHandle); void CkDtObj_putHour(HCkDtObj cHandle, int newVal);` |
| `Minute` | property, read/write | `int CkDtObj_getMinute(HCkDtObj cHandle); void CkDtObj_putMinute(HCkDtObj cHandle, int newVal);` |
| `Month` | property, read/write | `int CkDtObj_getMonth(HCkDtObj cHandle); void CkDtObj_putMonth(HCkDtObj cHandle, int newVal);` |
| `Second` | property, read/write | `int CkDtObj_getSecond(HCkDtObj cHandle); void CkDtObj_putSecond(HCkDtObj cHandle, int newVal);` |
| `StructTmMonth` | property, read/write | `int CkDtObj_getStructTmMonth(HCkDtObj cHandle); void CkDtObj_putStructTmMonth(HCkDtObj cHandle, int newVal);` |
| `StructTmYear` | property, read/write | `int CkDtObj_getStructTmYear(HCkDtObj cHandle); void CkDtObj_putStructTmYear(HCkDtObj cHandle, int newVal);` |
| `Utc` | property, read/write | `BOOL CkDtObj_getUtc(HCkDtObj cHandle); void CkDtObj_putUtc(HCkDtObj cHandle, BOOL newVal);` |
| `Year` | property, read/write | `int CkDtObj_getYear(HCkDtObj cHandle); void CkDtObj_putYear(HCkDtObj cHandle, int newVal);` |
| `DeSerialize` | method | `void CkDtObj_DeSerialize(HCkDtObj cHandle, const char *serializedDtObj);` |
| `Serialize` | method | `BOOL CkDtObj_Serialize(HCkDtObj cHandle, HCkString outStr); const char *CkDtObj_serialize(HCkDtObj cHandle);` |

## Properties

### DtObj.Day

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

```c
int CkDtObj_getDay(HCkDtObj cHandle);
void CkDtObj_putDay(HCkDtObj cHandle, int newVal);
```

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

### DtObj.Hour

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

```c
int CkDtObj_getHour(HCkDtObj cHandle);
void CkDtObj_putHour(HCkDtObj cHandle, int newVal);
```

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

### DtObj.Minute

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

```c
int CkDtObj_getMinute(HCkDtObj cHandle);
void CkDtObj_putMinute(HCkDtObj cHandle, int newVal);
```

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

### DtObj.Month

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

```c
int CkDtObj_getMonth(HCkDtObj cHandle);
void CkDtObj_putMonth(HCkDtObj cHandle, int newVal);
```

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

### DtObj.Second

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

```c
int CkDtObj_getSecond(HCkDtObj cHandle);
void CkDtObj_putSecond(HCkDtObj cHandle, int newVal);
```

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

### DtObj.StructTmMonth

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

```c
int CkDtObj_getStructTmMonth(HCkDtObj cHandle);
void CkDtObj_putStructTmMonth(HCkDtObj cHandle, int newVal);
```

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

### DtObj.StructTmYear

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

```c
int CkDtObj_getStructTmYear(HCkDtObj cHandle);
void CkDtObj_putStructTmYear(HCkDtObj cHandle, int newVal);
```

The year represented as the number of years since 1900.

### DtObj.Utc

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

```c
BOOL CkDtObj_getUtc(HCkDtObj cHandle);
void CkDtObj_putUtc(HCkDtObj cHandle, BOOL newVal);
```

`TRUE` if this is a UTC time, otherwise `FALSE` if this is a local time.

### DtObj.Year

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

```c
int CkDtObj_getYear(HCkDtObj cHandle);
void CkDtObj_putYear(HCkDtObj cHandle, int newVal);
```

The year, such as 2012.

## Methods

### DtObj.DeSerialize

`Chilkat 11.7.0 · c · DtObj · DeSerialize · method`

```c
void CkDtObj_DeSerialize(HCkDtObj cHandle, const char *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 · c · DtObj · Serialize · method`

```c
BOOL CkDtObj_Serialize(HCkDtObj cHandle, HCkString outStr);
const char *CkDtObj_serialize(HCkDtObj cHandle);
```

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.