Asn Delphi DLL Reference Documentation

Asn

Current Version: 9.5.0.73

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

Create/Dispose

var
myObject: HCkAsn;

begin
myObject := CkAsn_Create();

// ...

CkAsn_Dispose(myObject);
end;
function CkAsn_Create: HCkAsn; stdcall;

Creates an instance of the HCkAsn 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 CkAsn_Dispose(handle: HCkAsn); stdcall;

Objects created by calling CkAsn_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

BoolValue
function CkAsn_getBoolValue(objHandle: HCkAsn): wordbool; stdcall;
procedure CkAsn_putBoolValue(objHandle: HCkAsn; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.49

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

top
Constructed
function CkAsn_getConstructed(objHandle: HCkAsn): wordbool; stdcall;
Introduced in version 9.5.0.49

True 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
procedure CkAsn_getContentStr(objHandle: HCkAsn; outPropVal: HCkString); stdcall;
procedure CkAsn_putContentStr(objHandle: HCkAsn; newPropVal: PWideChar); stdcall;
function CkAsn__contentStr(objHandle: HCkAsn): PWideChar; stdcall;
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
procedure CkAsn_getDebugLogFilePath(objHandle: HCkAsn; outPropVal: HCkString); stdcall;
procedure CkAsn_putDebugLogFilePath(objHandle: HCkAsn; newPropVal: PWideChar); stdcall;
function CkAsn__debugLogFilePath(objHandle: HCkAsn): 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:

  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
function CkAsn_getIntValue(objHandle: HCkAsn): Integer; stdcall;
procedure CkAsn_putIntValue(objHandle: HCkAsn; newPropVal: Integer); stdcall;
Introduced in version 9.5.0.49

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

top
LastErrorHtml
procedure CkAsn_getLastErrorHtml(objHandle: HCkAsn; outPropVal: HCkString); stdcall;
function CkAsn__lastErrorHtml(objHandle: HCkAsn): 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.

top
LastErrorText
procedure CkAsn_getLastErrorText(objHandle: HCkAsn; outPropVal: HCkString); stdcall;
function CkAsn__lastErrorText(objHandle: HCkAsn): 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.

top
LastErrorXml
procedure CkAsn_getLastErrorXml(objHandle: HCkAsn; outPropVal: HCkString); stdcall;
function CkAsn__lastErrorXml(objHandle: HCkAsn): 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.

top
LastMethodSuccess
function CkAsn_getLastMethodSuccess(objHandle: HCkAsn): wordbool; stdcall;
procedure CkAsn_putLastMethodSuccess(objHandle: HCkAsn; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

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.

top
NumSubItems
function CkAsn_getNumSubItems(objHandle: HCkAsn): Integer; stdcall;
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
procedure CkAsn_getTag(objHandle: HCkAsn; outPropVal: HCkString); stdcall;
function CkAsn__tag(objHandle: HCkAsn): PWideChar; stdcall;
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
function CkAsn_getTagValue(objHandle: HCkAsn): Integer; stdcall;
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
function CkAsn_getVerboseLogging(objHandle: HCkAsn): wordbool; stdcall;
procedure CkAsn_putVerboseLogging(objHandle: HCkAsn; 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.

top
Version
procedure CkAsn_getVersion(objHandle: HCkAsn; outPropVal: HCkString); stdcall;
function CkAsn__version(objHandle: HCkAsn): PWideChar; stdcall;

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

top

Methods

AppendBigInt
function CkAsn_AppendBigInt(objHandle: HCkAsn;
    encodedBytes: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
AppendBits
function CkAsn_AppendBits(objHandle: HCkAsn;
    encodedBytes: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
AppendBool
function CkAsn_AppendBool(objHandle: HCkAsn;
    value: wordbool): wordbool; stdcall;
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 True for success, False for failure.

top
AppendContextConstructed
function CkAsn_AppendContextConstructed(objHandle: HCkAsn;
    tag: Integer): wordbool; stdcall;
Introduced in version 9.5.0.50

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

Returns True for success, False for failure.

top
AppendContextPrimitive
function CkAsn_AppendContextPrimitive(objHandle: HCkAsn;
    tag: Integer;
    encodedBytes: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
AppendInt
function CkAsn_AppendInt(objHandle: HCkAsn;
    value: Integer): wordbool; stdcall;
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 True for success, False for failure.

top
AppendNull
function CkAsn_AppendNull(objHandle: HCkAsn): wordbool; stdcall;
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 True for success, False for failure.

top
AppendOctets
function CkAsn_AppendOctets(objHandle: HCkAsn;
    encodedBytes: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
AppendOid
function CkAsn_AppendOid(objHandle: HCkAsn;
    oid: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
AppendSequence
function CkAsn_AppendSequence(objHandle: HCkAsn): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top
AppendSequence2
function CkAsn_AppendSequence2(objHandle: HCkAsn): wordbool; stdcall;
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 True for success, False for failure.

top
AppendSequenceR
function CkAsn_AppendSequenceR(objHandle: HCkAsn): HCkAsn; stdcall;
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 CkAsn_AppendSet(objHandle: HCkAsn): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top
AppendSet2
function CkAsn_AppendSet2(objHandle: HCkAsn): wordbool; stdcall;
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 True for success, False for failure.

top
AppendSetR
function CkAsn_AppendSetR(objHandle: HCkAsn): HCkAsn; stdcall;
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 CkAsn_AppendString(objHandle: HCkAsn;
    strType: PWideChar;
    value: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
AppendTime
function CkAsn_AppendTime(objHandle: HCkAsn;
    timeFormat: PWideChar;
    dateTimeStr: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
AsnToXml
function CkAsn_AsnToXml(objHandle: HCkAsn;
    outStr: HCkString): wordbool; stdcall;
function CkAsn__asnToXml(objHandle: HCkAsn): PWideChar; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top
DeleteSubItem
function CkAsn_DeleteSubItem(objHandle: HCkAsn;
    index: Integer): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top
GetBinaryDer
function CkAsn_GetBinaryDer(objHandle: HCkAsn;
    outBytes: HCkByteData): wordbool; stdcall;
Introduced in version 9.5.0.49

Returns the ASN.1 in binary DER form.

Returns True for success, False for failure.

top
GetEncodedContent
function CkAsn_GetEncodedContent(objHandle: HCkAsn;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkAsn__getEncodedContent(objHandle: HCkAsn;
    encoding: PWideChar): PWideChar; stdcall;
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 True for success, False for failure.

top
GetEncodedDer
function CkAsn_GetEncodedDer(objHandle: HCkAsn;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkAsn__getEncodedDer(objHandle: HCkAsn;
    encoding: PWideChar): PWideChar; stdcall;
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 True for success, False for failure.

top
GetLastSubItem
function CkAsn_GetLastSubItem(objHandle: HCkAsn): HCkAsn; stdcall;
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 CkAsn_GetSubItem(objHandle: HCkAsn;
    index: Integer): HCkAsn; stdcall;
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 CkAsn_LoadAsnXml(objHandle: HCkAsn;
    xmlStr: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top
LoadBinary
function CkAsn_LoadBinary(objHandle: HCkAsn;
    derBytes: HCkByteData): wordbool; stdcall;
Introduced in version 9.5.0.49

Loads ASN.1 from binary DER.

Returns True for success, False for failure.

top
LoadBinaryFile
function CkAsn_LoadBinaryFile(objHandle: HCkAsn;
    path: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.49

Loads ASN.1 from a binary DER file.

Returns True for success, False for failure.

top
LoadEncoded
function CkAsn_LoadEncoded(objHandle: HCkAsn;
    asnContent: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
SaveLastError
function CkAsn_SaveLastError(objHandle: HCkAsn;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top
SetEncodedContent
function CkAsn_SetEncodedContent(objHandle: HCkAsn;
    encodedBytes: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
WriteBinaryDer
function CkAsn_WriteBinaryDer(objHandle: HCkAsn;
    path: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.49

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

Returns True for success, False for failure.

top