IMAPITable::GetStatus

Last modified: July 23, 2011

Applies to: Outlook

Returns the table's status and type.

HRESULT GetStatus(
ULONG FAR * lpulTableStatus,
ULONG FAR * lpulTableType
);

lpulTableStatus

[out] Pointer to a value indicating the status of the table. One of the following values can be returned:

TBLSTAT_COMPLETE

No operations are in progress.

TBLSTAT_QCHANGED

The contents of the table have expectantly changed. This status value is not returned for changes that result from sort or restriction operations.

TBLSTAT_RESTRICT_ERROR

An error occurred during an IMAPITable::Restrict operation.

TBLSTAT_RESTRICTING

An IMAPITable::Restrict operation is in progress.

TBLSTAT_SETCOL_ERROR

An error occurred during an IMAPITable::SetColumns operation.

TBLSTAT_SETTING_COLS

An IMAPITable::SetColumns operation is in progress.

TBLSTAT_SORT_ERROR

An error occurred during an IMAPITable::SortTable operation.

TBLSTAT_SORTING

An IMAPITable::SortTable operation is in progress.

lpulTableType

[out] Pointer to a value that indicates the table's type. One of the following three table types can be returned:

TBLTYPE_DYNAMIC

The table's contents are dynamic; the rows and column values can change as the underlying data changes.

TBLTYPE_KEYSET

The rows within the table are fixed, but the values of the columns within these rows are dynamic and can change as the underlying data changes.

TBLTYPE_SNAPSHOT

The table is static, and its contents do not change when the underlying data changes.

S_OK

The table's status was successfully returned.

The IMAPTable::GetStatus method retrieves information about a table's type and current status.

You can use GetStatus in conjunction with three other IMAPITable methods to monitor the status of those operations and determine the effect on the table. Call GetStatus after making one of the following IMAPITable calls:

For MFCMAPI sample code, see the following table.

File

Function

Comment

ContentsTableListCtrl.cpp

CContentsTableListCtrl::GetStatus

MFCMAPI uses the IMAPITable::GetStatus method to report the status of a table.

Show: