Méthode IMoniker ::Enum (objidl.h)

  • Article

Récupère un pointeur vers un énumérateur pour les composants d’un moniker composite.

Syntaxe

HRESULT Enum(
  [in]  BOOL         fForward,
  [out] IEnumMoniker **ppenumMoniker
);

Paramètres

[in] fForward

Si true, énumère les monikers de gauche à droite. Si la valeur est FALSE, énumère de droite à gauche.

[out] ppenumMoniker

Pointeur vers une variable de pointeur IEnumMoniker qui reçoit le pointeur d’interface vers l’objet énumérateur pour le moniker. En cas de réussite, l’implémentation doit appeler AddRef sur l’objet énumérateur. Il incombe à l’appelant d’appeler Release. Si une erreur se produit ou si le moniker n’a aucun composant énumérable, l’implémentation définit *ppenumMoniker sur NULL.

Valeur retournée

Cette méthode peut retourner les valeurs de retour standard E_OUTOFMEMORY, E_UNEXPECTED et S_OK.

Remarques

Cette méthode doit fournir un pointeur IEnumMoniker à un énumérateur qui peut énumérer les composants d’un moniker. Par exemple, l’implémentation de la méthode IMoniker ::Enum pour un moniker composite générique crée un énumérateur qui peut déterminer les monikers individuels qui composent le composite, tandis que la méthode IMoniker ::Enum pour un moniker de fichier crée un énumérateur qui retourne des monikers représentant chacun des composants du chemin d’accès.

Notes aux appelants

Appelez cette méthode pour examiner les composants qui composent un moniker composite.

Notes aux implémenteurs

Si la nouvelle classe moniker n’a pas de structure interne perceptible, votre implémentation de cette méthode peut simplement retourner S_OK et définir ppenumMoniker sur NULL.

Notes spécifiques à l’implémentation

Implémentation Notes
Anti-moniker Cette méthode retourne S_OK et définit ppenumMoniker sur NULL.
Moniker de classe Cette méthode retourne S_OK et définit ppenumMoniker sur NULL.
Moniker de fichier Cette méthode retourne S_OK et définit ppenumMoniker sur NULL.
Moniker composite générique Si elle réussit, cette méthode retourne S_OK et retourne un énumérateur qui énumère les monikers de composant qui composent le composite ; sinon, la méthode retourne E_OUTOFMEMORY.
Moniker d’élément Cette méthode retourne S_OK et définit ppenumMoniker sur NULL.
Moniker OBJREF Cette méthode retourne S_OK et définit ppenumMoniker sur NULL.
Moniker de pointeur Cette méthode retourne E_NOTIMPL.
Moniker d’URL Cette méthode retourne S_OK et définit ppenumMoniker sur NULL.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête objidl.h

Voir aussi

IEnumMoniker

IMoniker