Asn Delphi DLL Reference Documentation
Asn
Current Version: 10.1.2
For creating, loading, parsing, converting, and saving ASN.1
Create/Dispose
var myObject: HCkAsn; begin myObject := CkAsn_Create(); // ... CkAsn_Dispose(myObject); end;
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.
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
procedure CkAsn_putBoolValue(objHandle: HCkAsn; newPropVal: wordbool); stdcall;
The ASN.1 item's boolean value if it is a boolean item.
topConstructed
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).
topContentStr
procedure CkAsn_putContentStr(objHandle: HCkAsn; newPropVal: PWideChar); stdcall;
function CkAsn__contentStr(objHandle: HCkAsn): PWideChar; stdcall;
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).
See the notes about PWideChar memory ownership and validity.
topDebugLogFilePath
procedure CkAsn_putDebugLogFilePath(objHandle: HCkAsn; newPropVal: PWideChar); stdcall;
function CkAsn__debugLogFilePath(objHandle: HCkAsn): PWideChar; stdcall;
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
See the notes about PWideChar memory ownership and validity.
IntValue
procedure CkAsn_putIntValue(objHandle: HCkAsn; newPropVal: Integer); stdcall;
The ASN.1 item's integer value if it is a small integer item.
topLastErrorHtml
function CkAsn__lastErrorHtml(objHandle: HCkAsn): PWideChar; stdcall;
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
See the notes about PWideChar memory ownership and validity.
topLastErrorText
function CkAsn__lastErrorText(objHandle: HCkAsn): PWideChar; stdcall;
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
See the notes about PWideChar memory ownership and validity.
LastErrorXml
function CkAsn__lastErrorXml(objHandle: HCkAsn): PWideChar; stdcall;
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkAsn_putLastMethodSuccess(objHandle: HCkAsn; newPropVal: wordbool); stdcall;
Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
topNumSubItems
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.
topTag
function CkAsn__tag(objHandle: HCkAsn): PWideChar; stdcall;
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
See the notes about PWideChar memory ownership and validity.
topTagValue
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
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.
topVersion
function CkAsn__version(objHandle: HCkAsn): PWideChar; stdcall;
Version of the component/library, such as "10.1.0"
See the notes about PWideChar memory ownership and validity.
Methods
AppendBigInt
encodedBytes: PWideChar;
encoding: PWideChar): wordbool; stdcall;
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.
AppendBits
encodedBytes: PWideChar;
encoding: PWideChar): wordbool; stdcall;
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.
topAppendBool
value: wordbool): wordbool; stdcall;
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.
topAppendContextConstructed
tag: Integer): wordbool; stdcall;
Appends an ASN.1 context-specific constructed item to the caller's sub-items.
Returns True for success, False for failure.
AppendContextPrimitive
tag: Integer;
encodedBytes: PWideChar;
encoding: PWideChar): wordbool; stdcall;
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.
topAppendInt
value: Integer): wordbool; stdcall;
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.
topAppendNull
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.
topAppendOctets
encodedBytes: PWideChar;
encoding: PWideChar): wordbool; stdcall;
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.
topAppendOid
oid: PWideChar): wordbool; stdcall;
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.
topAppendSequence
Appends an ASN.1 sequence item to the caller's sub-items.
Returns True for success, False for failure.
AppendSequence2
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.
topAppendSequenceR
Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.
Returns nil on failure
topAppendSet
Appends an ASN.1 set item to the caller's sub-items.
Returns True for success, False for failure.
AppendSet2
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.
topAppendSetR
Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.
Returns nil on failure
topAppendString
strType: PWideChar;
value: PWideChar): wordbool; stdcall;
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.
topAppendTime
timeFormat: PWideChar;
dateTimeStr: PWideChar): wordbool; stdcall;
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.
topAsnToXml
outStr: HCkString): wordbool; stdcall;
function CkAsn__asnToXml(objHandle: HCkAsn): PWideChar; stdcall;
Converts ASN.1 to XML and returns the XML string.
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
DeleteSubItem
index: Integer): wordbool; stdcall;
Discards the Nth sub-item. (The 1st sub-item is at index 0.)
Returns True for success, False for failure.
topGetBinaryDer
GetEncodedContent
encoding: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkAsn__getEncodedContent(objHandle: HCkAsn;
encoding: PWideChar): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topGetEncodedDer
encoding: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkAsn__getEncodedDer(objHandle: HCkAsn;
encoding: PWideChar): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
GetLastSubItem
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
topGetSubItem
index: Integer): HCkAsn; stdcall;
Returns the Nth ASN.1 sub-item. The 1st sub-item is at index 0.
Returns nil on failure
LoadAsnXml
xmlStr: PWideChar): wordbool; stdcall;
Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).
Returns True for success, False for failure.
LoadBd
Loads ASN.1 from the binary DER contained in bd.
Returns True for success, False for failure.
LoadBinary
LoadBinaryFile
path: PWideChar): wordbool; stdcall;
Loads ASN.1 from a binary DER file.
Returns True for success, False for failure.
LoadEncoded
asnContent: PWideChar;
encoding: PWideChar): wordbool; stdcall;
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.
SetEncodedContent
encodedBytes: PWideChar;
encoding: PWideChar): wordbool; stdcall;
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.
topWriteBd
WriteBinaryDer
path: PWideChar): wordbool; stdcall;
Writes the ASN.1 in binary DER form to a file.
Returns True for success, False for failure.