MailGetSort

The MailGetSort function retrieves the information about the current sort order for the specified mail handle.

Syntax

BOOL MailSetSort (HANDLE hMail, PMAILSORTINFO pInfo);

At a Glance

Header file: Msgstore.h
Platforms: H/PC
Versions: 2.0 and later

Parameters

hMail
Handle to the open mail context as returned by the MailOpen function.
pInfo
Receives the sort informatioin.

Return Values

This function returns TRUE if the sort information is retrieved, FALSE if the mail handle is invalid.

Remarks

Before calling the MailGetSort function, you should call MailFirst to update the number of applicable messages. To get extended error information, call MailError or MailErrorMsg.