MessageSet SQL Server Reference Documentation
MessageSet
Current Version: 11.6.0
Object Creation
DECLARE @hr int
DECLARE @messageSet int
EXEC @hr = sp_OACreate 'Chilkat.MessageSet', @messageSet OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- ... use @messageSet ...
EXEC @hr = sp_OADestroy @messageSetT-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.MessageSet.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 @messageSet, '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
Count
Returns the number of unique message identifiers currently stored in the set. A newly created MessageSet has a count of 0.
The identifiers are maintained in ascending numeric order. They are interpreted as UIDs when HasUids is 10
DebugLogFilePath
EXEC sp_OASetProperty @messageSet, '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.
HasUids
EXEC sp_OASetProperty @messageSet, 'HasUids', @iValue
Indicates how the numeric identifiers in this message set are interpreted:
10
Changing this property only changes how the existing numeric values are interpreted. It does not convert, validate, reorder, or clear the identifiers.
An IMAP UID is stable only within its mailbox and while that mailbox's UIDVALIDITY remains unchanged. Sequence numbers are temporary and can change when messages are added or expunged.
Set this property consistently before passing a manually constructed message set to an Imap method. The string formats produced by ToCommaSeparatedStr and ToCompactString contain only the numeric values and do not include this setting.
LastBinaryResult
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 @messageSet, '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.
topVerboseLogging
EXEC sp_OASetProperty @messageSet, '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
ContainsId
Returns 1msgId is present in the message set; otherwise, returns 0
The comparison is numeric only. The HasUids setting does not participate in the comparison.
FromCompactString
Clears the identifiers currently stored in this object and loads the compact message-set representation in str. The existing HasUids setting is preserved.
str is parsed. If parsing fails, the message set remains empty.An empty string succeeds and leaves the set empty. Valid identifiers are unsigned 32-bit decimal values from 1 through 4294967295. The value 0 is not accepted. Values too large for an unsigned 32-bit integer cause the method to fail.
The syntax uses commas to separate values or ranges, and a colon to specify an inclusive ascending range. A single range may contain at most 500,001 identifiers; equivalently, the ending value minus the starting value cannot exceed 500000.
Whitespace is accepted around values, commas, and colons. This includes spaces, tabs, carriage returns, and line feeds. Empty comma-separated elements and unrecognized non-numeric elements are intentionally ignored. If str is nonempty and no valid identifier is loaded, the method returns 0
Descending ranges, ranges containing 0, wildcard ranges such as 1:*, malformed range syntax, oversized ranges, and numeric overflow cause the method to return 0
On success, duplicate identifiers are removed and the resulting identifiers are stored in ascending numeric order. The serialized form contains only the numbers and does not indicate whether they are UIDs or sequence numbers.
Use ToCompactString to generate the canonical compact representation.
GetId
Returns the message identifier at the zero-based index specified by index. Identifiers are returned in ascending numeric order.
If index is negative or is greater than or equal to Count, this method returns 0xFFFFFFFF.
0xFFFFFFFF can also be stored in the set. Check index against Count before calling this method when that value could be present.InsertId
Adds id to the message set and maintains the identifiers in ascending numeric order.
- If
idis already present, no duplicate is added. - If
idis0, the set is unchanged. - The value
0xFFFFFFFFis accepted.
The HasUids setting determines whether the stored values are interpreted as UIDs or sequence numbers.
RemoveId
Removes the identifier whose raw numeric value equals id. If the value is not present, the set is unchanged.
The comparison is numeric only and does not depend on HasUids. The remaining identifiers stay in ascending numeric order.
Subtract
Removes from this message set every identifier whose raw numeric value is present in msgSet. Values not present in this set are ignored.
The comparison is numeric only; the HasUids values of the two objects are not compared. This object's HasUids value is preserved, and the remaining identifiers stay in ascending numeric order.
Passing the same object as msgSet clears the set. Passing an empty set leaves this set unchanged.
For meaningful IMAP results, both objects should represent identifiers of the same type and from the same mailbox.
ToCommaSeparatedStr
Returns the unique identifiers as a comma-separated string in ascending numeric order. An empty set returns an empty string.
For example, a set containing the identifiers 1 through 5 returns 1,2,3,4,5.
The returned string contains only the numeric values; it does not include the HasUids setting.
Returns NULL on failure
ToCompactString
Returns the unique identifiers in ascending numeric order using compact IMAP message-set syntax. Consecutive identifiers are represented as an inclusive range. An empty set returns an empty string.
The returned string is canonical for the current set: identifiers are unique, sorted, and consecutive runs are compacted. It contains only the numeric values and does not include the HasUids setting.
Use FromCompactString to load this format.
Returns NULL on failure