IMAPITable::GetCollapseState
適用対象: Outlook 2013 | Outlook 2016
分類されたテーブルの現在の折りたたまれた状態または展開された状態を再構築するために必要なデータを返します。
HRESULT GetCollapseState(
ULONG ulFlags,
ULONG cbInstanceKey,
LPBYTE lpbInstanceKey,
ULONG FAR * lpcbCollapseState,
LPBYTE FAR * lppbCollapseState
);
パラメーター
ulFlags
予約;は 0 にする必要があります。
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 を呼び出します。