Vcl.JumpList.TCustomJumpList.DeleteList

Delphi

function DeleteList: Boolean;

C++

bool __fastcall DeleteList();

説明

アプリケーションがジャンプリストに対して定義した内容を削除し、その処理が成功した場合には True を、そうでなければ False を返します。

DeleteList は、アプリケーションのジャンプリストから、ジャンプリストコンポーネントを使用してアプリケーションが定義した設定を、削除します。それには次のものが含まれます：

カスタムカテゴリとカテゴリ項目
あなたのタスク
最近開いたファイルやよく開くファイルを、表示/非表示にする設定たとえば、両ファイルとも非表示にした場合、DeleteList は、Windows のデフォルトの動作を復元し、アプリケーションの最近開いたファイルを表示します。

メモ： DeleteList は、ジャンプリストコンポーネントからデータを削除せず、実際のジャンプリストからのみ削除します。DeleteList を呼び出した直後に UpdateList 呼び出した場合、両呼び出しの組み合わせは効果を失います。

DeleteList への呼び出しは、次の例外のいずれかを発生させます：

Exception	Exception.Message	シナリオ
EJumpListException	ジャンプリストの例外：エラー <code> が <Beginning List> で発生します。	ICustomDestinationList::BeginList がエラーコードを返し、ユーザーは OnListUpdateError イベントを処理しなかった、もしくは、イベントハンドラがエラーを処理対象と判別しなかった。
EJumpListException	ジャンプリストの例外：エラー <code> が <Committing List> で発生します。	ICustomDestinationList::CommitList がエラーコードを返し、ユーザーは OnListUpdateError イベントを処理しなかった、もしくは、イベントハンドラがエラーを処理対象と判別しなかった。