IMAPITable::GetCollapseState

适用于:Outlook 2013 | Outlook 2016

返回重新生成分类表的当前折叠或展开状态所需的数据。

HRESULT GetCollapseState(
ULONG ulFlags,
ULONG cbInstanceKey,
LPBYTE lpbInstanceKey,
ULONG FAR * lpcbCollapseState,
LPBYTE FAR * lppbCollapseState
);

参数

ulFlags

保留;必须为零。

cbInstanceKey

[in] lpbInstanceKey 参数指向的实例键中的字节计数。

lpbInstanceKey

[in]指向 PR_INSTANCE_KEY (PidTagInstanceKey 的指针,) 应重新生成当前折叠或展开状态的行的属性。 lpbInstanceKey 参数不能为 NULL。

lCollapseState

[out]指向 lppbCollapseState 参数指向的结构计数的指针。

lppbCollapseState

[out]指向包含描述当前表视图的数据的结构的指针的指针。

返回值

S_OK

分类表的状态已成功保存。

MAPI_E_BUSY

另一个操作正在进行中,该操作阻止操作启动。 应允许正在进行的操作完成,或者应停止该操作。

MAPI_E_NO_SUPPORT

该表不支持分类以及展开视图和折叠视图。

备注

IMAPITable::GetCollapseState 方法与 IMAPITable::SetCollapseState 方法配合使用,以更改用户对分类表的视图。 GetCollapseState 保存 SetCollapseState 用于重新生成分类表类别的相应视图所需的数据。 服务提供商确定要保存的数据。 但是,大多数实现 GetCollapseState 的 服务提供商会保存以下内容:

  • 排序键 (标准列和类别列) 。

  • 有关实例键表示的行的信息。

  • 用于还原表的折叠和展开类别的信息。

有关分类表的详细信息,请参阅 排序和分类

针对实现者的说明

将表的所有节点的当前状态存储在 lppbCollapseState 参数中。

给调用方的说明

在调用 SetCollapseState 之前,始终调用 GetCollapseState

另请参阅

IMAPITable::SetCollapseState

IMAPITable : IUnknown