---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: DtObj
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_DtObjRef.html
---
# Chilkat DtObj — SQL Server — v11.7.0

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

```sql
DECLARE @hr int
DECLARE @dtObj int
EXEC @hr = sp_OACreate 'Chilkat.DtObj', @dtObj OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @dtObj ...

EXEC @hr = sp_OADestroy @dtObj
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.DtObj.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @dtObj, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

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

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Day` | property, read/write | `EXEC sp_OAGetProperty @dtObj, 'Day', @iValue OUT EXEC sp_OASetProperty @dtObj, 'Day', @iValue` |
| `Hour` | property, read/write | `EXEC sp_OAGetProperty @dtObj, 'Hour', @iValue OUT EXEC sp_OASetProperty @dtObj, 'Hour', @iValue` |
| `Minute` | property, read/write | `EXEC sp_OAGetProperty @dtObj, 'Minute', @iValue OUT EXEC sp_OASetProperty @dtObj, 'Minute', @iValue` |
| `Month` | property, read/write | `EXEC sp_OAGetProperty @dtObj, 'Month', @iValue OUT EXEC sp_OASetProperty @dtObj, 'Month', @iValue` |
| `Second` | property, read/write | `EXEC sp_OAGetProperty @dtObj, 'Second', @iValue OUT EXEC sp_OASetProperty @dtObj, 'Second', @iValue` |
| `StructTmMonth` | property, read/write | `EXEC sp_OAGetProperty @dtObj, 'StructTmMonth', @iValue OUT EXEC sp_OASetProperty @dtObj, 'StructTmMonth', @iValue` |
| `StructTmYear` | property, read/write | `EXEC sp_OAGetProperty @dtObj, 'StructTmYear', @iValue OUT EXEC sp_OASetProperty @dtObj, 'StructTmYear', @iValue` |
| `Utc` | property, read/write | `EXEC sp_OAGetProperty @dtObj, 'Utc', @iValue OUT EXEC sp_OASetProperty @dtObj, 'Utc', @iValue` |
| `Year` | property, read/write | `EXEC sp_OAGetProperty @dtObj, 'Year', @iValue OUT EXEC sp_OASetProperty @dtObj, 'Year', @iValue` |
| `DeSerialize` | method | `EXEC sp_OAMethod @dtObj, 'DeSerialize', NULL, @serializedDtObj` |
| `Serialize` | method | `EXEC sp_OAMethod @dtObj, 'Serialize', @sResult OUT` |

## Properties

### DtObj.Day

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

```sql
EXEC sp_OAGetProperty @dtObj, 'Day', @iValue OUT
EXEC sp_OASetProperty @dtObj, 'Day', @iValue
```

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

### DtObj.Hour

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

```sql
EXEC sp_OAGetProperty @dtObj, 'Hour', @iValue OUT
EXEC sp_OASetProperty @dtObj, 'Hour', @iValue
```

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

### DtObj.Minute

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

```sql
EXEC sp_OAGetProperty @dtObj, 'Minute', @iValue OUT
EXEC sp_OASetProperty @dtObj, 'Minute', @iValue
```

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

### DtObj.Month

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

```sql
EXEC sp_OAGetProperty @dtObj, 'Month', @iValue OUT
EXEC sp_OASetProperty @dtObj, 'Month', @iValue
```

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

### DtObj.Second

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

```sql
EXEC sp_OAGetProperty @dtObj, 'Second', @iValue OUT
EXEC sp_OASetProperty @dtObj, 'Second', @iValue
```

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

### DtObj.StructTmMonth

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

```sql
EXEC sp_OAGetProperty @dtObj, 'StructTmMonth', @iValue OUT
EXEC sp_OASetProperty @dtObj, 'StructTmMonth', @iValue
```

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

### DtObj.StructTmYear

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

```sql
EXEC sp_OAGetProperty @dtObj, 'StructTmYear', @iValue OUT
EXEC sp_OASetProperty @dtObj, 'StructTmYear', @iValue
```

The year represented as the number of years since 1900.

### DtObj.Utc

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

```sql
EXEC sp_OAGetProperty @dtObj, 'Utc', @iValue OUT
EXEC sp_OASetProperty @dtObj, 'Utc', @iValue
```

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

### DtObj.Year

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

```sql
EXEC sp_OAGetProperty @dtObj, 'Year', @iValue OUT
EXEC sp_OASetProperty @dtObj, 'Year', @iValue
```

The year, such as 2012.

## Methods

### DtObj.DeSerialize

`Chilkat 11.7.0 · sqlserver · DtObj · DeSerialize · method`

```sql
EXEC sp_OAMethod @dtObj, 'DeSerialize', NULL, @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 · sqlserver · DtObj · Serialize · method`

```sql
EXEC sp_OAMethod @dtObj, 'Serialize', @sResult OUT
```

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

