TDtObj Delphi ActiveX Reference Documentation
Importing the Chilkat ActiveX into Delphi
Important: Whenever upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.
Two things are required to use an ActiveX in Delphi:
- The ActiveX DLL needs to be registered via regsvr32 on the system where the
Delphi application runs. See How To Register ActiveX DLLs for detailed information.
- The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard
to import the Chilkat type library. This creates the following files: Chilkat_v9_5_0_TLB.pas and
Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.
To import the Chilkat type library, do the following:
- In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
- Find "Chilkat ActiveX v9.5.0" in the list and select it. This will only appear in the list if the
ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll) has been registered w/ regsvr32.
- Check the "Generate Component Wrappers" checkbox.
- Select a directory where the unit files (.pas and .dcr) will be generated.
- Select "Create Unit" and then "Finish".
- Add the .pas to your Delphi project.
To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_TLB" to
the "uses" statement. For example:
Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_v9_5_0_TLB;
obj := TDtObj.Create(Self);
// When finished, free the object instance.
property Day: Integer
The day of the month. The valid values for this member are 1 through 31.
property DebugLogFilePath: WideString
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.
property Hour: Integer
The hour. The valid values for this member are 0 through 23.
property LastBinaryResult: OleVariant readonly
Introduced in version 184.108.40.206
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).
property LastErrorHtml: WideString readonly
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.
property LastErrorText: WideString readonly
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.
property LastErrorXml: WideString readonly
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.
property LastMethodSuccess: Integer
Introduced in version 220.127.116.11
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.
property LastStringResult: WideString readonly
Introduced in version 18.104.22.168
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).
Long Strings Returned by ActiveX Methods in SQL Server
property LastStringResultLen: Integer readonly
Introduced in version 22.214.171.124
The length, in characters, of the string contained in the LastStringResult property.
property Minute: Integer
The minute. The valid values for this member are 0 through 59.
property Month: Integer
The month. The valid values for this member are 1 through 12 where 1 = January and 12 = December.
property Second: Integer
The second. The valid values for this member are 0 through 59.
property StructTmMonth: Integer
The month. The valid values for this member are 0 through 11 where 0 = January and 11 = December.
property StructTmYear: Integer
The year represented as the number of years since 1900.
property Utc: Integer
1 if this is a UTC time, otherwise 0 if this is a local time.
property VerboseLogging: Integer
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.
property Version: WideString readonly
Version of the component/library, such as "126.96.36.199"
property Year: Integer
The year, such as 2012.
procedure DeSerialize(serializedDtObj: WideString);
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.
function Serialize(): WideString;
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 a zero-length WideString on failure