TransportGetInboxId

This function return the service identifier of the Inbox folder on a mail server.

At a Glance

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

Syntax

BOOL TransportGetInboxID(HANDLE hService, LPWSTR *pszInboxID);

Parameters

hService: [in] Handle to a private SERVICE structure.
pszInboxID: [out] Pointer to a null-terminated string. This function returns the identifier of the Inbox folder in this parameter.

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.

The client is responsible for calling TransportFreeFolderId to free storage allocated on the server by this function.