IMAPIContainer::GetHierarchyTable

Article
08/28/2006

The GetHierarchyTable method returns a pointer to the container's hierarchy table.

Syntax

HRESULT GetHierarchyTable (
  ULONG ulFlags,
  LPMAPITABLE FAR * lppTable
);

Parameters

ulFlags
[in] Ignored.
lppTable
[out] Reference to the hierarchy table object, implemented on IMAPITable.

Return Values

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

S_OK
Indicates success.
MAPI_E_NO_SUPPORT
The container has no child containers and cannot provide a hierarchy table.

Remarks

The GetHierarchyTable method returns a pointer to the container's hierarchy table, which holds summary information about the child containers within the container. For example, folder hierarchy tables hold information about child folders.

Containers that have no child containers return MAPI_E_NO_SUPPORT from their implementations of GetHierarchyTable.

The following IMAPITable methods are supported for folder hierarchy tables in Windows Mobile Messaging:

String and binary contents table columns can be truncated. Typically, providers return 255 characters. Because you cannot know ahead of time whether or not a table includes truncated columns, assume that a column is truncated if the length of the column is either 255 or 510 bytes. You can always retrieve the full value of a truncated column from the object directly by using its entry identifier to open it and then calling the IMAPIProp::GetProps method.

Depending on the provider implementation, restrictions and sorting operations can apply to an entire string or to the truncated version of that string.

Requirements

Pocket PC: Windows Mobile 2002 and later
OS Versions: Windows CE 3.0 and later
Header: mapidefs.h
Library: cemapi.lib

Share via