MAPIFolder.GetTable(Object, Object) Method

Reference

Definition

Namespace:: Microsoft.Office.Interop.Outlook

Assembly:: Microsoft.Office.Interop.Outlook.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Obtains a Table object that contains items filtered by Filter.

public Microsoft.Office.Interop.Outlook.Table GetTable (object Filter, object TableContents);

Public Function GetTable (Optional Filter As Object, Optional TableContents As Object) As Table

Parameters

Filter: Object

A filter in Microsoft Jet or DAV Searching and Locating (DASL) syntax that specifies the criteria for items in the parent Folder.

TableContents: Object

Specifies the type of items in the folder that GetTable returns. The default is olUserItems.

Returns

Table

A Table that contains items in the parent Folder that meet the criteria in Filter. By default, TableContents is olUserItems and the returned Table contains only the filtered items that are not hidden.

Remarks

If Filter is a blank string or the Filter parameter is omitted, GetTable returns a Table with rows representing all the items in the Folder. If Filter is a blank string or the Filter parameter is omitted and TableContents is olHiddenItems, GetTable returns a Table with rows representing all the hidden items in the Folder.

For more information on filters, see Filtering Items and Referencing Properties by Namespace.

GetTable returns a Table with the default column set for the folder type of the parent Folder. To modify the default column set, use the Add(String), Remove(Object), or RemoveAll() methods of the Columns collection object. When TableContents is olHiddenItems, the default column set is always the default column set for a mail folder even though the parent Folder might be, for example, a Contacts folder. For more information on default column sets, see Default Properties Displayed in a Table Object

You can use Restrict(String) to apply subsequent filters to a Table that is based on the Folder object.

Applies to