Partager via

BeginEnumeration, fonction

  • Article

Réinitialise un énumérateur au début de l’énumération.

Notes

Cette API est destinée à un usage interne uniquement. Elle n’est pas destinée à être utilisée dans le code du développeur.

Syntaxe

HRESULT BeginEnumeration (
   [in] int               vFunc,
   [in] IWbemClassObject* ptr,
   [in] LONG              lEnumFlags
);

Paramètres

vFunc
[in] Ce paramètre est inutilisé.

ptr
[in] Pointeur vers une instance IWbemClassObject.

lEnumFlags
[in] Combinaison de bits des indicateurs ou valeurs décrits dans la section Remarks qui contrôle les propriétés incluses dans l’énumération.

Valeur retournée

Les valeurs suivantes renvoyées par cette fonction sont définies dans le fichier d’en-tête WbemCli.h, ou vous pouvez les définir comme constantes dans votre code :

Constant Valeur Description
WBEM_E_INVALID_PARAMETER 0x80041008 La combinaison d’indicateurs dans lEnumFlags n’est pas valide ou un argument non valide a été spécifié.
WBEM_E_UNEXPECTED 0x8004101d Un deuxième appel à BeginEnumeration a été effectué sans appel intermédiaire à EndEnumeration.
WBEM_E_OUT_OF_MEMORY 0x80041006 La mémoire disponible est insuffisante pour commencer une nouvelle énumération.
WBEM_S_NO_ERROR 0 L’appel de fonction a abouti.

Notes

Cette fonction encapsule un appel à la méthode IWbemClassObject::BeginEnumeration.

Les indicateurs qui peuvent être passés en tant qu’argument lEnumFlags sont définis dans l’argument WbemCli.h, ou vous pouvez les définir en tant que constantes dans votre code. Vous pouvez combiner un indicateur de chaque groupe avec n’importe quel indicateur d’un autre groupe. Toutefois, les indicateurs du même groupe s’excluent mutuellement.

Groupe 1

Constant Valeur Description
WBEM_FLAG_KEYS_ONLY 0x4 Incluez les propriétés qui constituent la clé uniquement.
WBEM_FLAG_REFS_ONLY 0x8 Incluez uniquement les propriétés qui sont des références d’objet.

Groupe 2

Constant Valeur Description
WBEM_FLAG_SYSTEM_ONLY 0x30 Limitez l’énumération aux propriétés système uniquement.
WBEM_FLAG_NONSYSTEM_ONLY 0x40 Incluez les propriétés locales et propagées, mais excluez les propriétés système de l’énumération.

Pour les classes :

Constant Valeur Description
WBEM_FLAG_CLASS_OVERRIDES_ONLY 0x100 Limiter l’énumération aux propriétés remplacées dans la définition de classe.
WBEM_FLAG_CLASS_LOCAL_AND_OVERRIDES 0x100 Limiter l’énumération aux propriétés remplacées dans la définition de classe actuelle et aux nouvelles propriétés définies dans la classe.
WBEM_MASK_CLASS_CONDITION 0x300 Masque (plutôt qu’un indicateur) à appliquer à une valeur lEnumFlags pour vérifier si WBEM_FLAG_CLASS_OVERRIDES_ONLY ou WBEM_FLAG_CLASS_LOCAL_AND_OVERRIDES est défini.
WBEM_FLAG_LOCAL_ONLY 0x10 Limiter l’énumération aux propriétés définies ou modifiées dans la classe elle-même.
WBEM_FLAG_PROPAGATED_ONLY 0x20 Limiter l’énumération aux propriétés héritées des classes de base.

Pour les instances :

Constant Valeur Description
WBEM_FLAG_LOCAL_ONLY 0x10 Limiter l’énumération aux propriétés définies ou modifiées dans la classe elle-même.
WBEM_FLAG_PROPAGATED_ONLY 0x20 Limiter l’énumération aux propriétés héritées des classes de base.

Spécifications

Plateformes : Consultez Configuration requise.

En-tête : WMINet_Utils.idl

Versions de .NET Framework : disponibles depuis la version 4.7.2

Voir aussi