Utils Component

Properties   Methods   Events   Config Settings   Errors  

The Utils component offers a selection of popular helper methods that may be of use in a variety of scenarios.

Syntax

nsoftware.SecureBlackbox.Utils

Remarks

If you need to resolve a hostname to an IP address, encode a string using a specific character encoding, or compose a multipart message, look no further. This is exactly what Utils is intended for. Below is a summary of little useful features that this class can help you with.

Encoding and decoding

• Encode binary data to base64 and decode it back (Base64Encode and Base64Decode)
• Hex-encode and decode (HexEncode and HexDecode)
• Encode and decode dates - particularly handy when working with other suite components that expect string dates (StringToDate, DateToString)
• Convert object identifiers from and to string representation (StringToOid, OidToString)
• Convert string to any supported character encoding (StringEncode and StringDecode).

Networking helpers

• Get local network parameters with GetLocalIP and GetLocalDNSName
• Resolve remote domain names into IP addresses (GetRemoteIP)
• URL-encode and decode HTTP and other data (UrlEncode and UrlDecode).

Work with multipart MIME messages

• Compose a multipart body with AddPartFromBytes and SaveMultipartToBytes
• Load and process existing multiparts with LoadMultipartFromBytes and GetPartToBytes.

Utils class also offers a useful GetErrorDescription method that lets you obtain a human-readable message for every SecureBlackbox error code you might get. // base64Encode byte[] bytes = ("Life is like riding a bicycle. To keep your balance," + " you must keep moving. (Albert Einstein)").getBytes(); String base64Encoded = utils.base64Encode(bytes,false); System.out.println(base64Encoded); // base64Decode String decoded = new String(utils.base64Decode(base64Encoded,false)); System.out.println(decoded); // Example: Using another SecureBlackBox component to get a string // and convert it to a Java Date object MessageVerifier verifier = new MessageVerifier(); verifier.setInputFile("signedMessage.bin"); verifier.setOutputFile("output.txt"); verifier.verify(); String verifiedDate = verifier.getValidatedSigningTime(); // Retrieving the string: 2024-05-17 13:25:26 Date date = utils.stringToDate(verifiedDate); // Using utils to convert it System.out.println(date); // Output : Fri May 17 13:25:26 CEST 2024 // Retrieving remote IP String hostName = "nsoftware.com"; System.out.println("Hostname: " + hostName + " has this IP: " + utils.getRemoteIP("www.nsoftware.com",false,dmAuto,"",60)); // Output: Hostname: nsoftware.com has this IP: 52.168.9.41 // Hex Encode byte[] bytes = ("Genius is one percent inspiration and " + "ninety-nine percent perspiration.(Thomas Edison)").getBytes(); String hexEncoded = utils.hexEncode(bytes); System.out.println(hexEncoded); // Hex Decode String decoded = new String(utils.hexDecode(hexEncoded)); System.out.println(decoded);

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

MultipartMessage Property (Utils Component)

Lists the content of the multipart message.

Syntax

• C#
• VB.NET

public MultipartMessagePartList MultipartMessage { get; }

Public Property MultipartMessage As MultipartMessagePartList

Remarks

This property provides access to all parts contained in or to be added to the multipart message.

This property is not available at design time.

NameValuePairs Property (Utils Component)

A current list of (name, value) pairs.

Syntax

• C#
• VB.NET

public StringNameValuePairList NameValuePairs { get; }

Public ReadOnly Property NameValuePairs As StringNameValuePairList

Remarks

Use this property to access the elements of the (name, value) pair list. Use LoadNameValuePairs and SaveNameValuePairs methods to serialize and deserialize the list to a string, and methods such as SetValueByName or RemoveNameValuePair to manage the list.

This property is read-only and not available at design time.

AddPartFromBytes Method (Utils Component)

Adds a new part to MultipartMessage from the specified byte array.

Syntax

• C#
• VB.NET

public int AddPartFromBytes(byte[] data);

Public Function AddPartFromBytes(ByVal Data As Byte()) As Integer

Remarks

The method adds a new part to MultipartMessage list with the specified data as the part's content.

Returns the index of the added part.

AddPartFromFile Method (Utils Component)

Adds a new part to MultipartMessage from the specified file.

Syntax

• C#
• VB.NET

public int AddPartFromFile(string fileName);

Public Function AddPartFromFile(ByVal FileName As String) As Integer

Remarks

The method adds a new part to MultipartMessage list with the specified file data as the part's content.

Returns the index of the added part.

AddPartFromStream Method (Utils Component)

Adds a new part to MultipartMessage from the provided stream.

Syntax

• C#
• VB.NET

public int AddPartFromStream(System.IO.Stream stream, bool closeStream);

Public Function AddPartFromStream(ByVal Stream As System.IO.Stream, ByVal CloseStream As Boolean) As Integer

Remarks

The method adds a new part to MultipartMessage with the provided stream data as the part's content. CloseStream specifies if the stream should be closed when the part is deleted or the multipart message is cleared.

Returns the index of the added part.

Base64Decode Method (Utils Component)

Decodes a base64 string to a byte array.

Syntax

• C#
• VB.NET

public byte[] Base64Decode(string value, bool useURLEncoding);

Public Function Base64Decode(ByVal Value As String, ByVal UseURLEncoding As Boolean) As Byte()

Remarks

Use this method to decode a base64-encoded string to a byte array. The UseURLEncoding parameter specifies whether the URL-Base64 modification should be used when decoding the string. byte[] arr = utils.Base64Decode("SGVsbG8sIHdvcmxkIQ==", false);

Base64Encode Method (Utils Component)

Encodes a byte array in base64.

Syntax

• C#
• VB.NET

public string Base64Encode(byte[] bytes, bool useURLEncoding);

Public Function Base64Encode(ByVal Bytes As Byte(), ByVal UseURLEncoding As Boolean) As String

Remarks

Use this method to encode binary data contained in Bytes to a base64 string. The UseURLEncoding parameter specifies whether additional URL encoding should be applied to the resulting string (with + and / characters replaced with - and _, respectively). string encoded = utils.Base64Encode(buf, false);

Base64EncodeLines Method (Utils Component)

Encodes the Bytes array containing binary data to a multi-line Base64.

Syntax

• C#
• VB.NET

public string Base64EncodeLines(byte[] bytes, int lineLen);

Public Function Base64EncodeLines(ByVal Bytes As Byte(), ByVal LineLen As Integer) As String

Remarks

Use this method to encode large amounts of binary data to multi-line base64 strings. Use LineLen parameter to provide the maximal length of each base64 line.

Config Method (Utils Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DateToString Method (Utils Component)

Converts a variable of Date type to the respective string representation.

Syntax

• C#
• VB.NET

public string DateToString(DateTime value);

Public Function DateToString(ByVal Value As DateTime) As String

Remarks

Use this method to convert a value of a platform date type to a string representation accepted by various SecureBlackbox methods and properties.

DoAction Method (Utils Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetErrorDescription Method (Utils Component)

Returns an error description by an error code.

Syntax

• C#
• VB.NET

public string GetErrorDescription(int errorCode);

Public Function GetErrorDescription(ByVal ErrorCode As Integer) As String

Remarks

Use this method to get a human readable description of an error by its code. Returns an empty string if the error code is not recognized.

GetLocalDNSName Method (Utils Component)

Returns the DNS name of the local system.

Syntax

• C#
• VB.NET

public string GetLocalDNSName();

Public Function GetLocalDNSName() As String

Remarks

Use this property to get the registered DNS or network name of the local system.

GetLocalIP Method (Utils Component)

Returns the primary IP address of the local system.

Syntax

• C#
• VB.NET

public string GetLocalIP(bool IPv6);

Public Function GetLocalIP(ByVal IPv6 As Boolean) As String

Remarks

Use this method to obtain the default IP address of the local system.

GetLocalIPs Method (Utils Component)

Returns a list of local IP addresses.

Syntax

• C#
• VB.NET

public string GetLocalIPs(bool IPv4, bool IPv6);

Public Function GetLocalIPs(ByVal IPv4 As Boolean, ByVal IPv6 As Boolean) As String

Remarks

Use this method to request a list of all local IP addresses available in the system. Set IPv4 and IPv6 as required to filter IPv4 and IPv6 interfaces in or out respectively.

GetPartToBytes Method (Utils Component)

Saves the data from the specified part to a byte array.

Syntax

• C#
• VB.NET

public byte[] GetPartToBytes(int index);

Public Function GetPartToBytes(ByVal Index As Integer) As Byte()

Remarks

Use this method to store the data of the specified part to a byte array.

Index must be greater than or equal to 0, and less than the part count.

GetPartToFile Method (Utils Component)

Saves the data from the specified part to a file.

Syntax

• C#
• VB.NET

public void GetPartToFile(int index, string fileName);

Public Sub GetPartToFile(ByVal Index As Integer, ByVal FileName As String)

Remarks

Use this method to store the data of the specified part to a file.

Index must be greater than or equal to 0, and less than the part count.

GetPartToStream Method (Utils Component)

Saves the data from the specified part to a stream.

Syntax

• C#
• VB.NET

public void GetPartToStream(int index, System.IO.Stream stream);

Public Sub GetPartToStream(ByVal Index As Integer, ByVal Stream As System.IO.Stream)

Remarks

Use this method to store the data of the specified part to a stream.

Index must be greater than or equal to 0, and less than the part count.

GetRemoteIP Method (Utils Component)

Gets the IP address of a remote host.

Syntax

• C#
• VB.NET

public string GetRemoteIP(string hostName, bool IPv6, int DNSMode, string DNSServers, int timeout);

Public Function GetRemoteIP(ByVal HostName As String, ByVal IPv6 As Boolean, ByVal DNSMode As Integer, ByVal DNSServers As String, ByVal Timeout As Integer) As String

Remarks

Use this property to resolve the address of a remote host using the provided DNS settings. Set IPv6 to true to force resolution of both IPv4 and IPv6 addresses.

Use the Timeout setting to specify maximal resolution time, and the DNSServer parameter to list the addresses of DNS servers to use for address resolution. Separate individual servers in the list with commas or semicolons. If an empty server list is provided, the component will use the list of servers configured in the system.

Use one of the below DNS modes:

GetRemoteIPs Method (Utils Component)

Resolves IP addresses available for a hostname.

Syntax

• C#
• VB.NET

public string GetRemoteIPs(string hostName, bool IPv4, bool IPv6, int DNSMode, string DNSServers, int timeout);

Public Function GetRemoteIPs(ByVal HostName As String, ByVal IPv4 As Boolean, ByVal IPv6 As Boolean, ByVal DNSMode As Integer, ByVal DNSServers As String, ByVal Timeout As Integer) As String

Remarks

Use this method to resolve all IP addresses available for the chosen hostname using the provided DNS settings. Use the Timeout setting to specify maximal resolution time. The DNSServer parameter lists the addresses of DNS servers to use for address resolution, separated with commas or semicolons. If an empty server list is provided, the component will use the list of servers configured in the system.

Use one of the below DNS modes:

GetValueByName Method (Utils Component)

Returns the value from the (name, value) pair list for the requested name.

Syntax

• C#
• VB.NET

public string GetValueByName(string name);

Public Function GetValueByName(ByVal Name As String) As String

Remarks

Use this method to obtain a matching value for the requested Name in the NameValuePairs list.

HexDecode Method (Utils Component)

Decodes a hex-encoded string into a byte array.

Syntax

• C#
• VB.NET

public byte[] HexDecode(string value);

Public Function HexDecode(ByVal Value As String) As Byte()

Remarks

Use this method to decode hex- (base16-) encoded strings to byte arrays. byte[] buf = utils.HexDecode("48656C6C6F2C20776F726C6421");

HexEncode Method (Utils Component)

Encodes a byte array to hex string.

Syntax

• C#
• VB.NET

public string HexEncode(byte[] bytes);

Public Function HexEncode(ByVal Bytes As Byte()) As String

Remarks

Use this method to encode a byte array, passed as Bytes, to a hex (base16) string.

IndexOfName Method (Utils Component)

Returns the index of the (name, value) pair in the list for the requested Name.

Syntax

• C#
• VB.NET

public int IndexOfName(string name);

Public Function IndexOfName(ByVal Name As String) As Integer

Remarks

Use this method to obtain the index of the (Name, Value) object in NameValuePairs list.

LoadMultipartFromBytes Method (Utils Component)

Loads a multipart message from the specified byte array to MultipartMessage .

Syntax

• C#
• VB.NET

public void LoadMultipartFromBytes(string contentType, byte[] data);

Public Sub LoadMultipartFromBytes(ByVal ContentType As String, ByVal Data As Byte())

Remarks

Use this method to load a multipart message from a byte array to MultipartMessage. You need to provide the content of the Content-Type header field together with the multipart body stored in the byte array.

After the data is loaded, you can get the data of each part by calling GetPartToBytes/GetPartToFile/GetPartToStream methods.

While loading data, the parts data is stored in temporary files/streams. If the TempPath config property is not empty, the parts data is stored to temporary files in that folder, otherwise the data is stored in memory streams.

LoadMultipartFromFile Method (Utils Component)

Loads a multipart message from the specified file to MultipartMessage .

Syntax

• C#
• VB.NET

public void LoadMultipartFromFile(string contentType, string fileName);

Public Sub LoadMultipartFromFile(ByVal ContentType As String, ByVal FileName As String)

Remarks

Use this method to load a multipart message from a file to MultipartMessage. You need to provide the content of the Content-Type header field together with the multipart body stored in the file.

After the file is loaded, you can get the data of each part by calling GetPartToBytes/GetPartToFile/GetPartToStream methods.

While loading data, the parts data is stored in temporary files/streams. If the TempPath config property is not empty, the parts data is stored to temporary files in that folder, otherwise the data is stored in memory streams.

LoadMultipartFromStream Method (Utils Component)

Loads a multipart message from the specified stream to MultipartMessage .

Syntax

• C#
• VB.NET

public void LoadMultipartFromStream(string contentType, System.IO.Stream stream);

Public Sub LoadMultipartFromStream(ByVal ContentType As String, ByVal Stream As System.IO.Stream)

Remarks

Use this method to load a multipart message from a stream to MultipartMessage. You need to provide the content of the Content-Type header field together with the multipart body stored in the stream.

After the stream is loaded, you can get the data of each part by calling GetPartToBytes/GetPartToFile/GetPartToStream methods.

While loading data, the parts data is stored in temporary files/streams. If the TempPath config property is not empty, the parts data is stored to temporary files in that folder, otherwise the data is stored in memory streams.

LoadNameValuePairs Method (Utils Component)

Loads a list of (name, value) pairs from a string.

Syntax

• C#
• VB.NET

public void LoadNameValuePairs(string data, string format, string nameValueSeparator, string pairSeparator, bool trimValues);

Public Sub LoadNameValuePairs(ByVal Data As String, ByVal Format As String, ByVal NameValueSeparator As String, ByVal PairSeparator As String, ByVal TrimValues As Boolean)

Remarks

Use this method to load a list of (name, value) pairs to NameValuePairs from a string. Provide one of the known formats via Format, and optionally pass the separators using NameValueSeparator and PairSeparator parameters.

The following pre-defined pair list formats are currently supported:

• rdn: a textual distinguished name encoding (/C=US/S=NC/O=Big Company)
• rdnbinary: a hex-encoded DER encoding of the ASN.1 RelativeDistinguishedName object

OidToString Method (Utils Component)

Converts a binary-encoded ASN.1 OID to its string representation.

Syntax

• C#
• VB.NET

public string OidToString(byte[] bytes);

Public Function OidToString(ByVal Bytes As Byte()) As String

Remarks

Use this method to convert binary-encoded OIDs (object identifiers) to their dotted string representations. byte[] oid_bin = new byte[] { 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x01, 0x06 }; string oid_str = utils.OidToString(oid_bin); Console.WriteLine(oid_str); // prints 2.16.840.1.101.3.4.1.6

RemoveNameValuePair Method (Utils Component)

Remove a (name, value) pair by name.

Syntax

• C#
• VB.NET

public bool RemoveNameValuePair(string name);

Public Function RemoveNameValuePair(ByVal Name As String) As Boolean

Remarks

Use this method to remove the (Name, Value) pair from the NameValuePairs list.

Reset Method (Utils Component)

Resets the component settings.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

Reset is a generic method available in every component.

SaveMultipartContentType Method (Utils Component)

Returns the value for Content-Type field.

Syntax

• C#
• VB.NET

public string SaveMultipartContentType();

Public Function SaveMultipartContentType() As String

Remarks

Call this method to get a value for Content-Type field after calling SaveMultipartToBytes or SaveMultipartToFile or SaveMultipartToStream.

SaveMultipartToBytes Method (Utils Component)

Saves the parts contained in MultipartMessage to a byte array.

Syntax

• C#
• VB.NET

public byte[] SaveMultipartToBytes(int multipartMode);

Public Function SaveMultipartToBytes(ByVal MultipartMode As Integer) As Byte()

Remarks

Use this method to store MultipartMessage to a temporary byte array.

Supported values for MultipartMode are:

To send the stored data to an HTTP server, follow the steps below:

1. Call SaveMultipartContentType method and assign the returned value to ContentType field of RequestParameters> property
2. Call PostBytes> method and pass the array to it

SaveMultipartToFile Method (Utils Component)

Saves the parts contained in MultipartMessage to the file.

Syntax

• C#
• VB.NET

public void SaveMultipartToFile(int multipartMode, string fileName);

Public Sub SaveMultipartToFile(ByVal MultipartMode As Integer, ByVal FileName As String)

Remarks

Use this method to store MultipartMessage to a temporary file.

Supported values for MultipartMode are:

To send the stored data to an HTTP server, follow the steps below:

1. Call SaveMultipartContentType method and assign the returned value to ContentType field of RequestParameters> property
2. Call PostFile> method and pass the filename to it

SaveMultipartToStream Method (Utils Component)

Saves the parts contained in MultipartMessage to the stream.

Syntax

• C#
• VB.NET

public void SaveMultipartToStream(int multipartMode, System.IO.Stream stream);

Public Sub SaveMultipartToStream(ByVal MultipartMode As Integer, ByVal Stream As System.IO.Stream)

Remarks

Use this method to store MultipartMessage to a temporary stream.

Supported values for MultipartMode are:

To send the stored data to an HTTP server, follow the steps below:

1. Call SaveMultipartContentType method and assign the returned value to ContentType field of RequestParameters> property
2. Call PostStream> method and pass the stream to it

SaveNameValuePairs Method (Utils Component)

Serializes the (name, value) pair list to a string.

Syntax

• C#
• VB.NET

public string SaveNameValuePairs(string format, string nameValueSeparator, string pairSeparator);

Public Function SaveNameValuePairs(ByVal Format As String, ByVal NameValueSeparator As String, ByVal PairSeparator As String) As String

Remarks

Use this method to save the contents of NameValuePairs to a string. Provide the desired format through the Format parameter, and entry separators (if required) via NameValueSeparator and PairSeparator parameters.

The following pre-defined pair list formats are currently supported:

• rdn: a textual distinguished name encoding (/C=US/S=NC/O=Big Company)
• rdnbinary: a hex-encoded DER encoding of the ASN.1 RelativeDistinguishedName object

SetValueByName Method (Utils Component)

Adds or updates the (name, value) pair by a name.

Syntax

• C#
• VB.NET

public int SetValueByName(string name, string value);

Public Function SetValueByName(ByVal Name As String, ByVal Value As String) As Integer

Remarks

This method updates the existing (Name, Value) pair with a new value, or adds a new pair if no such pair existed in NameValuePairs list.

StringDecode Method (Utils Component)

Converts a byte array to a string using a chosen encoding.

Syntax

• C#
• VB.NET

public string StringDecode(byte[] bytes, string encoding);

Public Function StringDecode(ByVal Bytes As Byte(), ByVal Encoding As String) As String

Remarks

Use this method to convert a byte array to a string using the required text encoding. The following encodings are currently supported: utf-8, utf16.

Leave Encoding empty to use the default code page configured in the system.

StringEncode Method (Utils Component)

Encodes a string to a byte array using a chosen character encoding.

Syntax

• C#
• VB.NET

public byte[] StringEncode(string value, string encoding);

Public Function StringEncode(ByVal Value As String, ByVal Encoding As String) As Byte()

Remarks

Use this method to convert a string to a byte array using the provided text encoding. The following encodings are currently supported: utf-8, utf16.

Leave Encoding empty to use the default code page configured in the system.

StringToDate Method (Utils Component)

Converts a date represented by a string to a respective Date object.

Syntax

• C#
• VB.NET

public DateTime StringToDate(string value);

Public Function StringToDate(ByVal Value As String) As DateTime

Remarks

Use this method to convert a date string that you obtained from a SecureBlackbox component property or method to a platform date object.

StringToOid Method (Utils Component)

Converts string OID representation to an ASN.1 byte array

Syntax

• C#
• VB.NET

public byte[] StringToOid(string value);

Public Function StringToOid(ByVal Value As String) As Byte()

Remarks

Use this method to convert an OID represented with a dotted string to the respective ASN.1 representation. string oid_str = "2.16.840.1.101.3.4.1.6"; byte[] oid_buf = utils.StringToOid(oid_str);

UrlDecode Method (Utils Component)

Decodes a URLEncoded string back into its original form.

Syntax

• C#
• VB.NET

public string UrlDecode(string value);

Public Function UrlDecode(ByVal Value As String) As String

Remarks

Use this method to decode the URLEncoded Value back to its original representation.

UrlEncode Method (Utils Component)

Encodes the provided string using URLEncode.

Syntax

• C#
• VB.NET

public string UrlEncode(string value);

Public Function UrlEncode(ByVal Value As String) As String

Remarks

Use this method to encode Value using URL Encoding (percent encoding), as defined in RFC 3986.

Error Event (Utils Component)

Informs about errors during cryptographic operations.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, UtilsErrorEventArgs e);

public class UtilsErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As UtilsErrorEventArgs)

Public Class UtilsErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

Component fires this event if an error happens during a cryptographic operation.

ErrorCode contains an error code and Description contains a textual description of the error that happened.

Notification Event (Utils Component)

This event notifies the application about an underlying control flow event.

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, UtilsNotificationEventArgs e);

public class UtilsNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As UtilsNotificationEventArgs)

Public Class UtilsNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

MultipartMessagePart Type

Represents a part of a multipart message transferred over HTTP.

Remarks

This type contains all information about a single part in a multipart message.

Fields

Constructors

• C#
• VB.NET

public MultipartMessagePart();

Public MultipartMessagePart()

StringNameValuePair Type

A simple name-value pair object.

Remarks

The component represents a name-value string pair used in a variety of network components.

Fields

Constructors

• C#
• VB.NET

public StringNameValuePair(string name, string value);

Public StringNameValuePair(ByVal Name As String, ByVal Value As String)

• C#
• VB.NET

public StringNameValuePair();

Public StringNameValuePair()

Config Settings (Utils Component)

Utils Config Settings

Base Config Settings

Trappable Errors (Utils Component)

Utils Errors