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。
lpcbCollapseState
[out] lppbCollapseState 參數所指向之結構計數的指標。
lppbCollapseState
[out]結構的指標,其中包含描述目前數據表檢視的數據。
傳回值
S_OK
已成功儲存分類數據表的狀態。
MAPI_E_BUSY
另一個作業正在進行中,無法啟動作業。 應該允許進行中的作業完成,或者應該停止作業。
MAPI_E_NO_SUPPORT
數據表不支援分類和展開和折疊檢視。
註解
IMAPITable::GetCollapseState 方法可與 IMAPITable::SetCollapseState 方法搭配運作,以變更使用者對分類數據表的檢視。 GetCollapseState 會儲存 SetCollapseState 重建分類數據表類別目錄的適當檢視所需的數據。 服務提供者會決定要儲存的數據。 不過,大部分實作 GetCollapseState 的服務提供者都會儲存下列專案:
排序索引鍵 (標準數據行和類別目錄數據行) 。
實例索引鍵所代表之數據列的相關信息。
還原數據表已折疊和展開類別的資訊。
如需分類數據表的詳細資訊,請參閱 排序和分類。
實作者注意事項
將數據表所有節點的目前狀態儲存在 lppbCollapseState 參數中。
呼叫者注意事項
呼叫 SetCollapseState 之前,請一律先呼叫 GetCollapseState。