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

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

```powerbuilder
oleobject loo_DtObj
integer li_rc

loo_DtObj = create oleobject
li_rc = loo_DtObj.ConnectToNewObject("Chilkat.DtObj")
if li_rc < 0 then
    destroy loo_DtObj
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_DtObj ...

destroy loo_DtObj
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.DtObj.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

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

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 DebugLogFilePath` | 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` | `blob LastBinaryResult (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` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `long LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `string LastStringResult (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` | `long LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `long VerboseLogging` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Day` | property, read/write | `long Day` |
| `Hour` | property, read/write | `long Hour` |
| `Minute` | property, read/write | `long Minute` |
| `Month` | property, read/write | `long Month` |
| `Second` | property, read/write | `long Second` |
| `StructTmMonth` | property, read/write | `long StructTmMonth` |
| `StructTmYear` | property, read/write | `long StructTmYear` |
| `Utc` | property, read/write | `long Utc` |
| `Year` | property, read/write | `long Year` |
| `DeSerialize` | method | `DeSerialize(string serializedDtObj)` |
| `Serialize` | method | `string Serialize()` |

## Properties

### DtObj.Day

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

```powerbuilder
long Day
```

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

### DtObj.Hour

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

```powerbuilder
long Hour
```

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

### DtObj.Minute

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

```powerbuilder
long Minute
```

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

### DtObj.Month

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

```powerbuilder
long Month
```

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

### DtObj.Second

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

```powerbuilder
long Second
```

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

### DtObj.StructTmMonth

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

```powerbuilder
long StructTmMonth
```

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

### DtObj.StructTmYear

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

```powerbuilder
long StructTmYear
```

The year represented as the number of years since 1900.

### DtObj.Utc

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

```powerbuilder
long Utc
```

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

### DtObj.Year

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

```powerbuilder
long Year
```

The year, such as 2012.

## Methods

### DtObj.DeSerialize

`Chilkat 11.7.0 · powerbuilder · DtObj · DeSerialize · method`

```powerbuilder
DeSerialize(string 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 · powerbuilder · DtObj · Serialize · method`

```powerbuilder
string Serialize()
```

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 `null` on failure

