MailGetFolderIdEx

This function, an extension of MailGetFolderId, retrieves the identification number of a mail folder from the message store and operates in a multiple hierarchy folder environment.

At a Glance

Syntax

BOOL MailGetFolderIdEx (HANDLE hMail, FID fidParent, FID* pfid, LPWSTR szName);

Parameters

hMail

[in] Handle to the mail context. This handle is created by the MailOpen function.

fidParent

[in] Folder identifier of the parent mail folder. If no parent folder exists, set fidParent to MAIL_FOLDER_NONE.

pfid

[out] Pointer to a folder identification number. If the folder name specified by szName exists in the message store, this function returns this parameter with the identification number associated with the name. This parameter does not return anything if the function fails.

szName

[in] Null-terminated string that contains the name of the mail folder being searched.

Return Values

TRUE indicates success. FALSE indicates failure. To get extended error information, call the function MailError or MailErrorMsg.

See Also

MailGetFolderName