IMAPITable::SetCollapseStateIMAPITable::SetCollapseState

適用されます: OutlookApplies to: Outlook

IMAPITable::GetCollapseStateメソッドへの前回の呼び出しによって保存されたデータを使用して分類されたテーブルの現在の展開または折りたたみの状態を再構築します。Rebuilds the current expanded or collapsed state of a categorized table using data that was saved by a prior call to the IMAPITable::GetCollapseState method.

HRESULT SetCollapseState(
ULONG ulFlags,
ULONG cbCollapseState,
LPBYTE pbCollapseState,
BOOKMARK FAR * lpbkLocation
);

�p�����[�^�[Parameters

ulFlagsulFlags

予約されています。0 にする必要があります。Reserved; must be zero.

cbCollapseStatecbCollapseState

[in]_PbCollapseState_パラメーターが指す構造体のバイト数をカウントします。[in] Count of bytes in the structure pointed to by the pbCollapseState parameter.

pbCollapseStatepbCollapseState

[in]テーブル ビューを再構築するために必要なデータを含む構造体へのポインター。[in] Pointer to the structures containing the data needed to rebuild the table view.

lpbkLocationlpbkLocation

[out]折りたたまれた状態または展開された状態の再構築するテーブル内の行を識別するブックマークへのポインター。[out] Pointer to a bookmark identifying the row in the table at which the collapsed or expanded state should be rebuilt. このブックマークとIMAPITable::GetCollapseStateへの呼び出し内の_lpbInstanceKey_パラメーターで渡されるインスタンスのキーは、同じ行を識別します。This bookmark and the instance key passed in the lpbInstanceKey parameter in the call to IMAPITable::GetCollapseState identify the same row.

�߂�lReturn value

S_OKS_OK

分類されたテーブルの状態が正常に再構築されました。The state of the categorized table was successfully rebuilt.

MAPI_E_BUSYMAPI_E_BUSY

別の操作は、操作の開始を防止する処理中です。Another operation is in progress that prevents the operation from starting. 実行中の操作を完了できるか、それを停止する必要があります。Either the operation in progress should be allowed to complete or it should be stopped.

MAPI_E_UNABLE_TO_COMPLETEMAPI_E_UNABLE_TO_COMPLETE

テーブルでは、折りたたまれた状態または展開されたビューの再構築が完了できませんでした。The table could not finish rebuilding the collapsed or expanded view.

備考Remarks

IMAPITable::SetCollapseStateメソッドは、テーブル ビューの展開または折りたたみの状態を再確立します。The IMAPITable::SetCollapseState method reestablishes the expanded or collapsed state of the table view. SetCollapseStateおよびGetCollapseStateが次のように協力しています。SetCollapseState and GetCollapseState work together as follows:

  1. 分類されたテーブルの状態を変更しようとしていますが、すべての変更前の状態に関連するデータを保存するのにはIMAPITable::GetCollapseStateが呼び出されます。When the state of a categorized table is about to change, IMAPITable::GetCollapseState is called to save all of the data pertaining to the state prior to the change.

  2. テーブルのビューを保存した状態に復元するにSetCollapseStateが呼び出されます。To restore the view of the table to its saved state, SetCollapseState is called. GetCollapseStateによって保存されたデータは、 SetCollapseStateに渡されます。The data saved by GetCollapseState is passed to SetCollapseState. SetCollapseStateは、状態を復元するのにはそのデータを使用することです。SetCollapseState is able to use that data to restore the state.

  3. SetCollapseStateは、出力パラメーターとしてGetCollapseStateへの入力として渡されるインスタンスのキーとして同じ行を識別するブックマークを返します。SetCollapseState returns as an output parameter a bookmark that identifies the same row as the instance key passed as input to GetCollapseState.

分類されたテーブルの詳細については、並べ替えや分類を参照してください。For more information about categorized tables, see Sorting and Categorization.

実装者へのメモNotes to implementers

並べ替え順序および制限、正確に同じであるGetCollapseStateの呼び出しの時と同様に確認する責任があります。You are responsible for verifying that the sort order and restrictions are exactly the same as they were at the time of the GetCollapseState call. 変更を行った結果を予測できるのでSetCollapseStateは呼び出されません。If a change has been made, SetCollapseState should not be called because the results can be unpredictable. GetCollapseStateとし、 SortTable SetCollapseStateを呼び出す前に、並べ替えのキーを変更するのなど、クライアントが呼び出す場合は、これが起こります。This can happen if, for example, a client calls GetCollapseState and then SortTable to change the sort key before calling SetCollapseState. 安全のため、保存されたデータは復元を続行する前に有効なことを確認してください。To be safe, check that the saved data is still valid before proceeding with the restoration.

呼び出し側への注意Notes to callers

SetCollapseStateを呼び出すには、する必要がありますが以前と呼ばれるGetCollapseStateTo call SetCollapseState, you must have previously called GetCollapseState. カテゴリを確立する並べ替え順序は、どちらのメソッドも同じにする必要があります。The sort order establishing the categories should be the same for both methods. 並べ替え順が異なる場合、 SetCollapseState操作の結果は予測できません。If the sort orders differ, the results of the SetCollapseState operation are unpredictable.

関連項目See also

IMAPITable::CreateBookmarkIMAPITable::CreateBookmark

IMAPITable::FreeBookmarkIMAPITable::FreeBookmark

IMAPITable::GetCollapseStateIMAPITable::GetCollapseState

IMAPITable: IUnknownIMAPITable : IUnknown