Méthode ICustomDestinationList ::BeginList (shobjidl_core.h)

Lance une session de génération pour une liste de raccourcis personnalisée.

Syntaxe

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

Paramètres

[out] pcMinSlots

Type : UINT*

Pointeur qui, lorsque cette méthode retourne, pointe vers le paramètre utilisateur actuel pour l’option Nombre d’éléments récents à afficher dans Jump Listes dans la barre des tâches et les fenêtres Propriétés du menu Démarrer. La valeur par défaut est 10. Il s’agit du nombre maximal de destinations qui seront affichées, et il s’agit d’un total de toutes les destinations, quelle que soit la catégorie. D’autres destinations peuvent être ajoutées, mais elles ne sont pas affichées dans l’interface utilisateur.

Une liste de raccourcis affiche toujours au moins autant d’emplacements : destinations et, s’il y a de la place, tâches.

Ce nombre n’inclut pas les séparateurs et les en-têtes de section tant que le nombre total de séparateurs et d’en-têtes ne dépasse pas quatre. Les séparateurs et les en-têtes de section au-delà des quatre premiers peuvent réduire le nombre de destinations affichées si l’espace est limité. Ce nombre n’affecte pas les entrées de commande standard pour l’épinglage ou le désépinglage, la fermeture de la fenêtre ou le lancement d’une nouvelle instance. Elle n’affecte pas non plus les tâches ou les éléments épinglés, dont le nombre peut être affiché en fonction de l’espace disponible pour la liste de raccourcis.

[in] riid

Type : REFIID

Référence à l’IID d’une interface à récupérer dans ppv, généralement IID_IObjectArray, qui représente tous les éléments actuellement stockés dans la liste des destinations supprimées pour l’application. Ces informations permettent de s’assurer que les éléments supprimés ne font pas partie de la nouvelle liste de raccourcis.

[out] ppv

Type : void**

Lorsque cette méthode est retournée, contient le pointeur d’interface demandé dans riid. Il s’agit généralement d’un IObjectArray, qui représente une collection d’objets IShellItem et IShellLink qui représentent les éléments supprimés.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Si une application a un ID de modèle utilisateur d’application explicite (AppUserModelID), vous devez appeler ICustomDestinationList ::SetAppID avant d’appeler cette méthode.

L’interface IObjectArray récupérée dans le paramètre ppv représente la même liste de destinations supprimées que celle récupérée via GetRemovedDestinations. Lorsqu’une nouvelle liste de raccourcis est générée, les applications doivent d’abord traiter toutes les destinations supprimées. Les données de suivi de n’importe quel élément de la liste supprimée doivent être effacées. Si une application tente d’inclure un élément via AppendCategory présent dans cette liste de destinations supprimées, l’appel AppendCategory échoue. Cela garantit que les applications respectent le choix des éléments supprimés par l’utilisateur. Une fois qu’un appel à CommitList a été effectué sans échec d’appel à AppendCategory en raison d’une tentative de rajouter un élément supprimé depuis BeginList, la liste des destinations supprimées est effacée. Après ce délai, un élément précédemment supprimé peut revenir à la liste des destinations si l’utilisateur continue à l’utiliser.

BeginList doit être appelé pour lancer la liste avant d’effectuer des appels pour la remplir via AppendCategory, AppendKnownCategory ou AddUserTasks.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	shobjidl_core.h (incluez Shobjidl.h)
Bibliothèque	Shell32.lib
DLL	Shell32.dll (version 6.1 ou ultérieure)

Voir aussi

ICustomDestinationList

Extensions de la barre des tâches