DtObj ActiveX Reference Documentation

DtObj

Current Version: 10.1.0

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.DtObj" instead of "Chilkat.DtObj"
For a specific major version, use "Chilkat.DtObj.<major_version>", such as "Chilkat.DtObj.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.DtObj")

(AutoIt)
$obj = ObjCreate("Chilkat.DtObj")

(Visual Basic 6.0)
Dim obj As New DtObj

(VBScript)
set obj = CreateObject("Chilkat.DtObj")

(Delphi)
obj := TDtObj.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.DtObj')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.DtObj")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.DtObj', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.DtObj");

Properties

Day
Day As Long

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

top
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
Hour
Hour As Long

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

top
LastBinaryResult
LastBinaryResult As Variant (read-only)

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Long

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
LastStringResult As String (read-only)

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top
Minute
Minute As Long

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

top
Month
Month As Long

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

top
Second
Second As Long

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

top
StructTmMonth
StructTmMonth As Long

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

top
StructTmYear
StructTmYear As Long

The year represented as the number of years since 1900.

top
Utc
Utc As Long

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

top
VerboseLogging
VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (read-only)

Version of the component/library, such as "9.5.0.94"

top
Year
Year As Long

The year, such as 2012.

top

Methods

DeSerialize
DeSerialize(serializedDtObj As String)

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.

top
Serialize
Serialize() As String

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 Nothing on failure

top