IMAPIContainer::GetContentsTable

Article
08/28/2006

The GetContentsTable method returns a pointer to the container's contents table.

Syntax

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

Parameters

ulFlags
[in] Ignored.
lppTable
[out] Reference to the contents 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 contents and cannot provide a contents table.

Remarks

The GetContentsTable method returns a pointer to the contents table of a container, which contains summary information about objects within the container. All of the supported IMAPITable methods are available for contents tables in Windows Mobile Messaging.

Contents tables have lengthy column sets. It is possible for some containers to have no contents, and these containers return MAPI_E_NO_SUPPORT from their implementations of GetContentsTable.

String and binary contents table columns can be truncated. Typically, providers return 255 characters. Because you cannot know in advance 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

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

Share via