TChilkatAsn Delphi ActiveX Reference Documentation

TChilkatAsn

Current Version: 9.5.0.73

For creating, loading, parsing, converting, and saving ASN.1

Importing the Chilkat ActiveX into Delphi

Important: When 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:

  1. 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.
  2. See also: ActiveX Registration Tutorial
  3. 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:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. 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.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) should be generated.
  5. Select "Create Unit" and then "Finish".
  6. 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:

uses
  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;

Object Creation

var
obj: TChilkatAsn;
...
begin
obj := TChilkatAsn.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

BoolValue
property BoolValue: Integer
Introduced in version 9.5.0.49

The ASN.1 item's boolean value if it is a boolean item.

top
Constructed
property Constructed: Integer readonly
Introduced in version 9.5.0.49

1 if this ASN.1 item is a constructed item. Sequence and Set items are constructed and can contain sub-items. All other tags (boolean, integer, octets, utf8String, etc.) are primitive (non-constructed).

top
ContentStr
property ContentStr: WideString
Introduced in version 9.5.0.49

The ASN.1 item's content if it is an ASN.1 string type (such as Utf8String, BmpString, PrintableString, VisibleString, T61String, IA5String, NumericString, or UniversalString).

top
DebugLogFilePath
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:

  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
IntValue
property IntValue: Integer
Introduced in version 9.5.0.49

The ASN.1 item's integer value if it is a small integer item.

top
LastBinaryResult
property LastBinaryResult: OleVariant readonly
Introduced in version 9.5.0.52

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

top
LastErrorText
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.

top
LastErrorXml
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.

top
LastMethodSuccess
property LastMethodSuccess: Integer
Introduced in version 9.5.0.52

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
property LastStringResult: WideString readonly
Introduced in version 9.5.0.52

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
property LastStringResultLen: Integer readonly
Introduced in version 9.5.0.53

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

top
NumSubItems
property NumSubItems: Integer readonly
Introduced in version 9.5.0.49

The number of sub-items contained within this ASN.1 item. Only constructed items, such as Sequence and Set will contain sub-iitems. Primitive items such as OIDs, octet strings, integers, etc. will never contain sub-items.

top
Tag
property Tag: WideString readonly
Introduced in version 9.5.0.49

The ASN.1 item's tag as a descriptive string. Possible values are:

boolean
integer
bitString
octets
null
oid
utf8String
relativeOid
sequence
set
numericString
printableString
t61String
ia5String
utcTime
bmpString

top
TagValue
property TagValue: Integer readonly
Introduced in version 9.5.0.49

The ASN.1 item's tag as a integer value. The integer values for possible tags are as follows:

boolean (1)
integer (2)
bitString (3)
octets (4)
null (5)
oid (6)
utf8String (12)
relativeOid (13)
sequence (16)
set (17)
numericString (18)
printableString (19)
t61String (20)
ia5String (22)
utcTime (23)
bmpString (30)

top
VerboseLogging
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.

top
Version
property Version: WideString readonly

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

top

Methods

AppendBigInt
function AppendBigInt(encodedBytes: WideString; encoding: WideString): Integer;
Introduced in version 9.5.0.49

Appends an ASN.1 integer, but one that is a big (huge) integer that is too large to be represented by an integer variable. The bytes composing the integer are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian. The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

top
AppendBits
function AppendBits(encodedBytes: WideString; encoding: WideString): Integer;
Introduced in version 9.5.0.49

Appends an ASN.1 bit string to the caller's sub-items. The bytes containing the bits are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian (MSB first). The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

top
AppendBool
function AppendBool(value: Integer): Integer;
Introduced in version 9.5.0.49

Appends an ASN.1 boolean item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.

Returns 1 for success, 0 for failure.

top
AppendContextConstructed
function AppendContextConstructed(tag: Integer): Integer;
Introduced in version 9.5.0.50

Appends an ASN.1 context-specific constructed item to the caller's sub-items.

Returns 1 for success, 0 for failure.

top
AppendContextPrimitive
function AppendContextPrimitive(tag: Integer; encodedBytes: WideString; encoding: WideString): Integer;
Introduced in version 9.5.0.50

Appends an ASN.1 context-specific primitive item to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

top
AppendInt
function AppendInt(value: Integer): Integer;
Introduced in version 9.5.0.49

Appends an ASN.1 integer item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.

Returns 1 for success, 0 for failure.

top
AppendNull
function AppendNull(): Integer;
Introduced in version 9.5.0.49

Appends an ASN.1 null item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.

Returns 1 for success, 0 for failure.

top
AppendOctets
function AppendOctets(encodedBytes: WideString; encoding: WideString): Integer;
Introduced in version 9.5.0.49

Appends an ASN.1 octet string to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

top
AppendOid
function AppendOid(oid: WideString): Integer;
Introduced in version 9.5.0.49

Appends an ASN.1 OID (object identifier) to the caller's sub-items. The OID is passed in string form, such as "1.2.840.113549.1.9.1".

Returns 1 for success, 0 for failure.

top
AppendSequence
function AppendSequence(): Integer;
Introduced in version 9.5.0.49

Appends an ASN.1 sequence item to the caller's sub-items.

Returns 1 for success, 0 for failure.

top
AppendSequence2
function AppendSequence2(): Integer;
Introduced in version 9.5.0.50

Appends an ASN.1 sequence item to the caller's sub-items, and updates the internal reference to point to the newly appended sequence item.

Returns 1 for success, 0 for failure.

top
AppendSequenceR
function AppendSequenceR(): TChilkatAsn;
Introduced in version 9.5.0.50

Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.

Returns nil on failure

top
AppendSet
function AppendSet(): Integer;
Introduced in version 9.5.0.49

Appends an ASN.1 set item to the caller's sub-items.

Returns 1 for success, 0 for failure.

top
AppendSet2
function AppendSet2(): Integer;
Introduced in version 9.5.0.50

Appends an ASN.1 set item to the caller's sub-items, and updates the internal reference to point to the newly appended set item.

Returns 1 for success, 0 for failure.

top
AppendSetR
function AppendSetR(): TChilkatAsn;
Introduced in version 9.5.0.50

Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.

Returns nil on failure

top
AppendString
function AppendString(strType: WideString; value: WideString): Integer;
Introduced in version 9.5.0.49

Appends a string item to the caller's sub-items. The strType specifies the type of string to be added. It may be "utf8", "ia5", "t61", "printable", "visible", "numeric", "universal", or "bmp". The value must conform to the ASN.1 restrictions imposed for a given string type. The "utf8", "bmp", and "universal" types have no restrictions on what characters are allowed. In general, unless a specific type of string is required, choose the "utf8" type.

Returns 1 for success, 0 for failure.

top
AppendTime
function AppendTime(timeFormat: WideString; dateTimeStr: WideString): Integer;
Introduced in version 9.5.0.49

Appends a UTCTime item to the caller's sub-items. The timeFormat specifies the format of the dateTimeStr. It should be set to "utc". (In the future, this method will be expanded to append GeneralizedTime items by using "generalized" for timeFormat.) To append the current date/time, set dateTimeStr equal to the empty string or the keyword "now". Otherwise, the dateTimeStr should be in the UTC time format "YYMMDDhhmm[ss]Z" or "YYMMDDhhmm[ss](+|-)hhmm".

Returns 1 for success, 0 for failure.

top
AsnToXml
function AsnToXml(): WideString;
Introduced in version 9.5.0.49

Converts ASN.1 to XML and returns the XML string.

Returns a zero-length WideString on failure

top
DeleteSubItem
function DeleteSubItem(index: Integer): Integer;
Introduced in version 9.5.0.49

Discards the Nth sub-item. (The 1st sub-item is at index 0.)

Returns 1 for success, 0 for failure.

top
GetBinaryDer
function GetBinaryDer(): OleVariant;
Introduced in version 9.5.0.49

Returns the ASN.1 in binary DER form.

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

top
GetEncodedContent
function GetEncodedContent(encoding: WideString): WideString;
Introduced in version 9.5.0.49

Returns the content of the ASN.1 item in encoded string form. The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns a zero-length WideString on failure

top
GetEncodedDer
function GetEncodedDer(encoding: WideString): WideString;
Introduced in version 9.5.0.49

Returns the binary DER in encoded string form. The encoding indicates the encoding and can be "base64", "hex", "uu", "quoted-printable", "base32", or "modbase64".

Returns a zero-length WideString on failure

top
GetLastSubItem
function GetLastSubItem(): TChilkatAsn;
Introduced in version 9.5.0.49

Returns the last ASN.1 sub-item. This method can be called immediately after any Append* method to access the appended item.

Returns nil on failure

top
GetSubItem
function GetSubItem(index: Integer): TChilkatAsn;
Introduced in version 9.5.0.49

Returns the Nth ASN.1 sub-item. The 1st sub-item is at index 0.

Returns nil on failure

top
LoadAsnXml
function LoadAsnXml(xmlStr: WideString): Integer;
Introduced in version 9.5.0.49

Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).

Returns 1 for success, 0 for failure.

top
LoadBinary
function LoadBinary(derBytes: OleVariant): Integer;
Introduced in version 9.5.0.49

Loads ASN.1 from binary DER.

Returns 1 for success, 0 for failure.

top
LoadBinaryFile
function LoadBinaryFile(path: WideString): Integer;
Introduced in version 9.5.0.49

Loads ASN.1 from a binary DER file.

Returns 1 for success, 0 for failure.

top
LoadEncoded
function LoadEncoded(asnContent: WideString; encoding: WideString): Integer;
Introduced in version 9.5.0.49

Loads ASN.1 from an encoded string. The encoding can be "base64", "hex", "uu", "quoted-printable", "base32", or "modbase64".

Returns 1 for success, 0 for failure.

top
SetEncodedContent
function SetEncodedContent(encodedBytes: WideString; encoding: WideString): Integer;
Introduced in version 9.5.0.49

Sets the content of this primitive ASN.1 item. The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

top
WriteBinaryDer
function WriteBinaryDer(path: WideString): Integer;
Introduced in version 9.5.0.49

Writes the ASN.1 in binary DER form to a file.

Returns 1 for success, 0 for failure.

top