Asn SQL Server Reference Documentation
Asn
Current Version: 11.6.0
Chilkat.Asn
Load ASN.1 from binary DER bytes, encoded text such as Base64 or hex,
files, or existing
Read the item tag, tag value, constructed/primitive state, sub-item
count, string content, boolean value, or integer value.
Append constructed
Add booleans, integers, big integers, bit strings, octet strings, OIDs,
strings, times, null values, and encoded byte content.
Add context-specific primitive or constructed items when working with
ASN.1 formats that use tagged application-specific structures.
Convert ASN.1 to XML for inspection or editing, load ASN.1 back from XML,
and output the result as binary or encoded DER.
Load, inspect, build, edit, and encode ASN.1 structures in DER or XML form.
Chilkat.Asn represents an ASN.1 item and its optional child
items. It can load ASN.1 from binary DER, encoded DER strings, files, or
BinData; expose tags, tag values, primitive content, boolean
and integer values, and child counts; build constructed structures such as
SEQUENCE and SET; append common primitive types
such as booleans, integers, big integers, bit strings, octets, OIDs, strings,
times, null values, and context-specific items; convert ASN.1 to XML; reload
from that XML form; and write the final structure back to DER.
Load DER data
BinData objects.
Inspect ASN.1 items
Build sequences and sets
SEQUENCE and SET items,
then add child ASN.1 values beneath them.
Append primitive values
Context-specific tags
DER and XML conversion
LoadBinary, LoadEncoded,
LoadBd, or LoadBinaryFile, inspect the tree with
Tag, Constructed, NumSubItems, and
GetSubItem, then extract primitive content or convert to XML
with AsnToXml. To create ASN.1, start with a constructed item,
append child values, and write the final DER with GetBinaryDer,
GetEncodedDer, WriteBd, or
WriteBinaryDer.
Object Creation
DECLARE @hr int
DECLARE @asn int
EXEC @hr = sp_OACreate 'Chilkat.Asn', @asn OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- ... use @asn ...
EXEC @hr = sp_OADestroy @asnT-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as sp_OACreate 'Chilkat.Asn.11' for Chilkat v11.*.*.
sp_OACreate returns an object token (an int) that is passed as the first argument of every sp_OAMethod, sp_OAGetProperty and sp_OASetProperty call, and released with sp_OADestroy. Objects returned by methods (such as an HttpResponse or JsonObject) are also tokens received through an int OUT parameter; they must likewise be destroyed, and the OUT parameter is NULL when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero @hr), sp_OAGetErrorInfo describes the error.
Data types: strings are nvarchar(4000); integers, booleans (1 or 0) and object tokens are int; dates are datetime. In the signatures on this page, @success, @iResult, @sResult and the like are the OUT variables receiving a method's return value, @iValue / @sValue receive or supply a property value, and the remaining @ variables are the method's arguments in order.
A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example DECLARE @tmp TABLE (outputLine ntext) followed by INSERT INTO @tmp EXEC sp_OAGetProperty @asn, 'LastErrorText'. See string length limitations for strings returned by sp_OAMethod calls.
Methods that pass or return raw byte arrays are not shown on this page, because varbinary(max) values cannot be exchanged through sp_OAMethod (see varbinary(max) limitation). Use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead. Binary properties (such as LastBinaryResult) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*Async) methods and event callbacks are not available from SQL Server.
Properties
BoolValue
EXEC sp_OASetProperty @asn, 'BoolValue', @iValue
The ASN.1 item's boolean value if it is a boolean item.
topConstructed
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).
ContentStr
EXEC sp_OASetProperty @asn, 'ContentStr', @sValue
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).
topDebugLogFilePath
EXEC sp_OASetProperty @asn, 'DebugLogFilePath', @sValue
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.
IntValue
EXEC sp_OASetProperty @asn, 'IntValue', @iValue
The ASN.1 item's integer value if it is a small integer item.
topLastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
LastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
EXEC sp_OASetProperty @asn, 'LastMethodSuccess', @iValue
Indicates the success or failure of the most recent method call: 1 means success, 0 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
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
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 bmpStringtop
TagValue
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
EXEC sp_OASetProperty @asn, 'VerboseLogging', @iValue
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.
Version
Methods
AppendBigInt
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.
AppendBits
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.
topAppendBool
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.
topAppendContextConstructed
Appends an ASN.1 context-specific constructed item to the caller's sub-items.
Returns 1 for success, 0 for failure.
AppendContextPrimitive
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.
topAppendInt
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.
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 1 for success, 0 for failure.
topAppendOctets
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.
topAppendOid
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.
topAppendSequence
Appends an ASN.1 sequence item to the caller's sub-items.
Returns 1 for success, 0 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 1 for success, 0 for failure.
topAppendSequenceR
Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.
Returns NULL on failure
AppendSet
Appends an ASN.1 set item to the caller's sub-items.
Returns 1 for success, 0 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 1 for success, 0 for failure.
topAppendSetR
Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.
Returns NULL on failure
AppendString
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.
topAppendTime
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.
topAsnToXml
Converts ASN.1 to XML and returns the XML string.
Returns NULL on failure
DeleteSubItem
Discards the Nth sub-item. (The 1st sub-item is at index 0.)
Returns 1 for success, 0 for failure.
topGetEncodedContent
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 NULL on failure
GetEncodedDer
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 NULL on failure
GetLastSubItem
Returns the last ASN.1 sub-item. This method can be called immediately after any Append* method to access the appended item.
Returns NULL on failure
GetSubItem
Returns the Nth ASN.1 sub-item. The 1st sub-item is at index 0.
Returns NULL on failure
LoadAsnXml
Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).
Returns 1 for success, 0 for failure.
LoadBd
Loads ASN.1 from the binary DER contained in bd.
Returns 1 for success, 0 for failure.
LoadBinaryFile
Loads ASN.1 from a binary DER file.
Returns 1 for success, 0 for failure.
LoadEncoded
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.
SetEncodedContent
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.
topWriteBd
WriteBinaryDer
Writes the ASN.1 in binary DER form to a file.
Returns 1 for success, 0 for failure.