MessageSet Delphi DLL Reference Documentation
MessageSet
Current Version: 10.1.0
Represents a collection of email message sequence numbers or UIDs on an IMAP server.
Create/Dispose
var myObject: HCkMessageSet; begin myObject := CkMessageSet_Create(); // ... CkMessageSet_Dispose(myObject); end;
Creates an instance of the HCkMessageSet object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkMessageSet_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.
Properties
Count
The number of message UIDs (or sequence numbers) in this message set.
topHasUids
procedure CkMessageSet_putHasUids(objHandle: HCkMessageSet; newPropVal: wordbool); stdcall;
If True then the message set contains UIDs, otherwise it contains sequence numbers.
topLastMethodSuccess
procedure CkMessageSet_putLastMethodSuccess(objHandle: HCkMessageSet; newPropVal: wordbool); stdcall;
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.
topMethods
ContainsId
msgId: LongWord): wordbool; stdcall;
Returns True if the msgId is contained in the message set.
topFromCompactString
str: PWideChar): wordbool; stdcall;
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
index: Integer): LongWord; stdcall;
Returns the message ID of the Nth message in the set. (indexing begins at 0). Returns 0xFFFFFFFF if the index is out of range.
InsertId
id: LongWord) stdcall;
Inserts a message ID into the set. If the ID already exists, a duplicate is not inserted.
topLoadTaskResult
Loads the message set from a completed asynchronous task.
Returns True for success, False for failure.
topRemoveId
id: LongWord) stdcall;
Removes a message ID from the set.
topToCommaSeparatedStr
outStr: HCkString): wordbool; stdcall;
function CkMessageSet__toCommaSeparatedStr(objHandle: HCkMessageSet): PWideChar; stdcall;
Returns a string of comma-separated message IDs. (This is the non-compact string format.)
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
topToCompactString
outStr: HCkString): wordbool; stdcall;
function CkMessageSet__toCompactString(objHandle: HCkMessageSet): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
top