MessageSet Unicode C Reference Documentation

MessageSet

Current Version: 11.0.0

Requires Chilkat Bundle License

Represents a collection of email message sequence numbers or UIDs on an IMAP server.

Create/Dispose

HCkMessageSetW instance = CkMessageSetW_Create();
// ...
CkMessageSetW_Dispose(instance);

HCkMessageSetW CkMessageSetW_Create(void);

Creates an instance of the HCkMessageSetW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkMessageSetW_Dispose(HCkMessageSetW handle);

Objects created by calling CkMessageSetW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkMessageSetW_Dispose.

Properties

Count

int CkMessageSetW_getCount(HCkMessageSetW cHandle);

The number of message UIDs (or sequence numbers) in this message set.

DebugLogFilePath

void CkMessageSetW_getDebugLogFilePath(HCkMessageSetW cHandle, HCkString retval);
void CkMessageSetW_putDebugLogFilePath(HCkMessageSetW cHandle, const wchar_t *newVal);
const wchar_t *CkMessageSetW_debugLogFilePath(HCkMessageSetW cHandle);

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.

More Information and Examples

Example showing how to use DebugLogFilePath.

HasUids

BOOL CkMessageSetW_getHasUids(HCkMessageSetW cHandle);
void CkMessageSetW_putHasUids(HCkMessageSetW cHandle, BOOL newVal);

If TRUE then the message set contains UIDs, otherwise it contains sequence numbers.

LastErrorHtml

void CkMessageSetW_getLastErrorHtml(HCkMessageSetW cHandle, HCkString retval);
const wchar_t *CkMessageSetW_lastErrorHtml(HCkMessageSetW cHandle);

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.

LastErrorText

void CkMessageSetW_getLastErrorText(HCkMessageSetW cHandle, HCkString retval);
const wchar_t *CkMessageSetW_lastErrorText(HCkMessageSetW cHandle);

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkMessageSetW_getLastErrorXml(HCkMessageSetW cHandle, HCkString retval);
const wchar_t *CkMessageSetW_lastErrorXml(HCkMessageSetW cHandle);

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.

LastMethodSuccess

BOOL CkMessageSetW_getLastMethodSuccess(HCkMessageSetW cHandle);
void CkMessageSetW_putLastMethodSuccess(HCkMessageSetW cHandle, BOOL newVal);

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.

VerboseLogging

BOOL CkMessageSetW_getVerboseLogging(HCkMessageSetW cHandle);
void CkMessageSetW_putVerboseLogging(HCkMessageSetW cHandle, BOOL newVal);

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.

Version

void CkMessageSetW_getVersion(HCkMessageSetW cHandle, HCkString retval);
const wchar_t *CkMessageSetW_version(HCkMessageSetW cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

ContainsId

BOOL CkMessageSetW_ContainsId(HCkMessageSetW cHandle, unsigned long msgId);

Returns TRUE if the msgId is contained in the message set.

FromCompactString

BOOL CkMessageSetW_FromCompactString(HCkMessageSetW cHandle, const wchar_t *str);

Loads the message set from a compact-string representation. Here are some examples:

Non-Compact String	Compact String
1,2,3,4,5	1:5
1,2,3,4,5,8,9,10	1:5,8:10
1,3,4,5,8,9,10	1,3:5,8:10

GetId

unsigned long CkMessageSetW_GetId(HCkMessageSetW cHandle, int index);

Returns the message ID of the Nth message in the set. (indexing begins at 0). Returns 0xFFFFFFFF if the index is out of range.

More Information and Examples

How to Download Messages in MessageSet One at a Time

InsertId

void CkMessageSetW_InsertId(HCkMessageSetW cHandle, unsigned long id);

Inserts a message ID into the set. If the ID already exists, a duplicate is not inserted.

LoadTaskResult

BOOL CkMessageSetW_LoadTaskResult(HCkMessageSetW cHandle, HCkTaskW task);

Introduced in version 9.5.0.52

Loads the message set from a completed asynchronous task.

Returns TRUE for success, FALSE for failure.

RemoveId

void CkMessageSetW_RemoveId(HCkMessageSetW cHandle, unsigned long id);

Removes a message ID from the set.

ToCommaSeparatedStr

BOOL CkMessageSetW_ToCommaSeparatedStr(HCkMessageSetW cHandle, const wchar_t *outStr);
const wchar_t *CkMessageSetW_toCommaSeparatedStr(HCkMessageSetW cHandle);

Returns a string of comma-separated message IDs. (This is the non-compact string format.)

Returns TRUE for success, FALSE for failure.

ToCompactString

BOOL CkMessageSetW_ToCompactString(HCkMessageSetW cHandle, const wchar_t *outStr);
const wchar_t *CkMessageSetW_toCompactString(HCkMessageSetW cHandle);

Returns the set of message IDs represented as a compact string. Here are some examples:

Non-Compact String	Compact String
1,2,3,4,5	1:5
1,2,3,4,5,8,9,10	1:5,8:10
1,3,4,5,8,9,10	1,3:5,8:10

Returns TRUE for success, FALSE for failure.