ICustomDestinationList::BeginList メソッド (shobjidl_core.h)

  • [アーティクル]

カスタムジャンプリストのビルドセッションを開始します。

構文

HRESULT BeginList(
  [out] UINT   *pcMinSlots,
  [in]  REFIID riid,
  [out] void   **ppv
);

パラメーター

[out] pcMinSlots

種類: UINT*

このメソッドが戻ったときに、[タスク バー] ウィンドウと [スタート] メニューの [プロパティ] ウィンドウの [ジャンプ] Listsオプションに表示する最近使用した項目の数] の現在のユーザー設定を指すポインター。 既定値は 10 です。 これは表示される宛先の最大数であり、カテゴリに関係なく、すべての宛先の合計です。 その他の宛先を追加することはできますが、UI には表示されません。

ジャンプ リストには常に、少なくともこの数のスロット (宛先) と、余裕がある場合はタスクが表示されます。

区切り記号とヘッダーの合計数が 4 を超えない限り、この数には区切り記号とセクション ヘッダーは含まれません。 区切り記号とセクション ヘッダーが最初の 4 つを超えると、スペースが制限されている場合に表示される宛先の数が減る可能性があります。 この番号は、ピン留めまたはピン留め解除、ウィンドウの閉じ、新しいインスタンスの起動の標準コマンド エントリには影響しません。 また、タスクやピン留めされたアイテムには影響しません。表示できる数は、ジャンプ リストで使用できる領域に基づいています。

[in] riid

種類: REFIID

ppv (通常はIID_IObjectArray) で取得されるインターフェイスの IID への参照。これは、アプリケーションの削除された宛先の一覧に現在格納されているすべての項目を表します。 この情報は、削除された項目が新しいジャンプ リストに含まれていないことを確認するために使用されます。

[out] ppv

型: void**

このメソッドが戻るとき、 には 、riid で要求されたインターフェイス ポインターが含まれます。 これは通常、削除されたアイテムを表す IShellItem オブジェクトと IShellLink オブジェクトのコレクションを表す IObjectArray です。

戻り値

種類: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

アプリケーションに明示的なアプリケーション ユーザー モデル ID (AppUserModelID) がある場合は、このメソッドを呼び出す前に ICustomDestinationList::SetAppID を 呼び出す必要があります。

ppv パラメーターで取得された IObjectArray インターフェイスは、GetRemovedDestinations を介して取得される削除された宛先の同じ一覧を表します。 新しいジャンプ リストが生成されている場合、アプリケーションは最初に削除された宛先を処理する必要があります。 削除されたリスト内のアイテムの追跡データをクリアする必要があります。 アプリケーションが、この削除された宛先リストに存在する AppendCategory を介して項目を含めようとすると、 AppendCategory 呼び出しは失敗します。 これにより、アプリケーションは削除された項目のユーザーの選択を尊重できます。 BeginList 以降に削除されたアイテムを再追加しようとしたために AppendCategory の呼び出しが失敗せず、CommitList の呼び出しが行われた後、削除された宛先リストはクリアされます。 その後、ユーザーがアイテムを引き続き使用する場合、以前に削除されたアイテムは宛先リストに戻ることができます。

AppendCategory、AppendKnownCategory、または AddUserTasks を使用してリストを設定する呼び出しを行う前に、BeginList を呼び出してリストを開始する必要があります。

要件

要件 値
サポートされている最小のクライアント Windows 7 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shobjidl_core.h (Shobjidl.h を含む)
Library Shell32.lib
[DLL] Shell32.dll (バージョン 6.1 以降)

こちらもご覧ください

ICustomDestinationList

タスク バー拡張機能