MessageSet Unicode C Reference Documentation

MessageSet

Current Version: 10.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.

top
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.

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

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top

Methods

ContainsId
BOOL CkMessageSetW_ContainsId(HCkMessageSetW cHandle, unsigned long msgId);

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

top
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

top
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
top
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.

top
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.

top
RemoveId
void CkMessageSetW_RemoveId(HCkMessageSetW cHandle, unsigned long id);

Removes a message ID from the set.

top
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.

top
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.

top