TransportGetFolders

This function returns a list of folders from a transport mail server.

At a Glance

Header file:	Msgstor2.h
Platforms:	H/PC 3.0
Windows CE versions:	2.10 and later

Syntax

BOOL TransportGetFolders(HANDLE hService, LPWSTR szParentID,
lpTransportFolderList *ppFolders);

Parameters

hService: [in] Handle to a private SERVICE structure.
szParentID: [in] Null-terminated string that contains the identifier of the parent folder. If szParentID is NULL, this function returns a list of top-level folders from the mail server.
ppFolders: [out] Pointer to the pointer to a TransportFolderList structure used by TransportGetFolders to return the folder list. TransportFolderList contains a list of TransportFolderInfo structures.

Return Values

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

Remarks

The transport service provider must implement this function in a DLL registered as a mail service. The Inbox application can then load this DLL and call this function.

This function only returns the first level of subfolders directly beneath the parent folder.

This functiononly sets the szFriendlyName and szServiceID members of the TransportFolderInfo structures in TransportFolderList, and ignores the fidStoreID member.