DtObj Delphi DLL Reference Documentation

DtObj

Current Version: 10.0.0

Create/Dispose

var
myObject: HCkDtObj;

begin
myObject := CkDtObj_Create();

// ...

CkDtObj_Dispose(myObject);
end;

function CkDtObj_Create: HCkDtObj; stdcall;

Creates an instance of the HCkDtObj object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkDtObj_Dispose(handle: HCkDtObj); stdcall;

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.

Properties

Day

function CkDtObj_getDay(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putDay(objHandle: HCkDtObj; newPropVal: Integer); stdcall;

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

DebugLogFilePath

procedure CkDtObj_getDebugLogFilePath(objHandle: HCkDtObj; outPropVal: HCkString); stdcall;
procedure CkDtObj_putDebugLogFilePath(objHandle: HCkDtObj; newPropVal: PWideChar); stdcall;
function CkDtObj__debugLogFilePath(objHandle: HCkDtObj): PWideChar; stdcall;

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:

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

Hour

function CkDtObj_getHour(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putHour(objHandle: HCkDtObj; newPropVal: Integer); stdcall;

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

LastErrorHtml

procedure CkDtObj_getLastErrorHtml(objHandle: HCkDtObj; outPropVal: HCkString); stdcall;
function CkDtObj__lastErrorHtml(objHandle: HCkDtObj): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkDtObj_getLastErrorText(objHandle: HCkDtObj; outPropVal: HCkString); stdcall;
function CkDtObj__lastErrorText(objHandle: HCkDtObj): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkDtObj_getLastErrorXml(objHandle: HCkDtObj; outPropVal: HCkString); stdcall;
function CkDtObj__lastErrorXml(objHandle: HCkDtObj): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkDtObj_getLastMethodSuccess(objHandle: HCkDtObj): wordbool; stdcall;
procedure CkDtObj_putLastMethodSuccess(objHandle: HCkDtObj; newPropVal: wordbool); stdcall;

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Minute

function CkDtObj_getMinute(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putMinute(objHandle: HCkDtObj; newPropVal: Integer); stdcall;

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

Month

function CkDtObj_getMonth(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putMonth(objHandle: HCkDtObj; newPropVal: Integer); stdcall;

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

Second

function CkDtObj_getSecond(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putSecond(objHandle: HCkDtObj; newPropVal: Integer); stdcall;

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

StructTmMonth

function CkDtObj_getStructTmMonth(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putStructTmMonth(objHandle: HCkDtObj; newPropVal: Integer); stdcall;

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

StructTmYear

function CkDtObj_getStructTmYear(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putStructTmYear(objHandle: HCkDtObj; newPropVal: Integer); stdcall;

The year represented as the number of years since 1900.

Utc

function CkDtObj_getUtc(objHandle: HCkDtObj): wordbool; stdcall;
procedure CkDtObj_putUtc(objHandle: HCkDtObj; newPropVal: wordbool); stdcall;

True if this is a UTC time, otherwise False if this is a local time.

VerboseLogging

function CkDtObj_getVerboseLogging(objHandle: HCkDtObj): wordbool; stdcall;
procedure CkDtObj_putVerboseLogging(objHandle: HCkDtObj; newPropVal: wordbool); stdcall;

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

Version

procedure CkDtObj_getVersion(objHandle: HCkDtObj; outPropVal: HCkString); stdcall;
function CkDtObj__version(objHandle: HCkDtObj): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Year

function CkDtObj_getYear(objHandle: HCkDtObj): Integer; stdcall;
procedure CkDtObj_putYear(objHandle: HCkDtObj; newPropVal: Integer); stdcall;

The year, such as 2012.

Methods

DeSerialize

procedure CkDtObj_DeSerialize(objHandle: HCkDtObj;
serializedDtObj: PWideChar) stdcall;

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.

Serialize

function CkDtObj_Serialize(objHandle: HCkDtObj;
outStr: HCkString): wordbool; stdcall;
function CkDtObj__serialize(objHandle: HCkDtObj): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.