Share via

IMailSyncHandler::GetFolderHierarchy (Compact 7)

  • Article

3/12/2014

The GetFolderHierarchy method is implemented by the transport to return the folder hierarchy tree to Messaging.

Syntax

HRESULT GetFolderHierarchy (
  FOLDERNODE ** ppRootNode
);

Parameters

  • ppRootNode
    [out] Reference to the root node of the folder hierarchy tree.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

  • S_OK
    Indicates success.
  • CEMAPI_E_MUST_SYNC_ONCE
    Indicates the transport cannot provide the folder hierarchy because the user has never performed a synchronization from their desktop computer to the device.

Remarks

When the transport returns CEMAPI_E_MUST_SYNC_ONCE, Messaging displays an appropriate message to the user to synchronize the e-mail before trying to access the folder hierarchy.

The transport may cache the most recent folder hierarchy so that it does not need to go online whenever GetFolderHierarchy is called.

The folder hierarchy tree should contain all folders that the user can select to synchronize.

Requirements

Header

cemapi.h

Library

cemapi.lib

See Also

Reference

IMailSyncHandler