IWSManSession ::Enumerate, méthode (wsmandisp.h)
Énumère une table, une collection de données ou une ressource de journal. Pour créer une requête, incluez un paramètre de filtre et un paramètre dialecte dans une énumération. Vous pouvez également utiliser un objet IWSManResourceLocator pour créer des requêtes. Pour plus d’informations, consultez Énumération ou liste de toutes les instances d’une ressource.
Syntaxe
HRESULT Enumerate(
[in] VARIANT resourceUri,
[in, optional] BSTR filter,
[in, optional] BSTR dialect,
[in] long flags,
[out] IDispatch **resultSet
);
Paramètres
[in] resourceUri
Identificateur de la ressource à récupérer.
La liste suivante contient les identificateurs que ce paramètre peut contenir :
- URI avec un ou plusieurs sélecteurs. Lorsque vous appelez la méthode Enumerate pour obtenir une ressource WMI, utilisez la propriété de clé ou les propriétés de l’objet.
- Vous pouvez utiliser des sélecteurs, des fragments ou desoptions. Pour plus d’informations, consultez IWSManResourceLocator.
- Référence du point de terminaison d’adressage WS , comme décrit dans la norme de protocole WS-Management. Pour plus d’informations sur la spécification publique du protocole WS-Management, consultez la page Index des spécifications de gestion.
[in, optional] filter
Filtre qui définit les éléments de la ressource qui sont retournés par l’énumération. Lorsque la ressource est énumérée, seuls les éléments qui correspondent aux critères de filtre sont retournés. L’inclusion d’un paramètre de filtre et d’un paramètre dialecte dans une énumération convertit l’énumération en requête.
Si vous avez un objet IWSManResourceLocator pour le paramètre resourceURI , ce paramètre ne doit pas être utilisé. Utilisez plutôt les fonctionnalités de sélecteur et de fragment d’IWSManResourceLocator.
[in, optional] dialect
Langue utilisée par le filtre. WQL, un sous-ensemble de SQL utilisé par WMI, est le seul langage pris en charge.
Si vous avez un objet IWSManResourceLocator pour le paramètre resourceURI , ce paramètre ne doit pas être utilisé. Utilisez plutôt les fonctionnalités de sélecteur et de fragment d’IWSManResourceLocator.
[in] flags
Ce paramètre doit contenir un indicateur dans l’énumération __WSManEnumFlags . Pour plus d’informations, consultez Constantes d’énumération.
[out] resultSet
Objet IWSManEnumerator qui contient les résultats de l’énumération.
Valeur retournée
Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.
Remarques
Appelez IWSManSession ::Enumerate pour démarrer une opération d’énumération. Par la suite, appelez IWSManEnumerator ::ReadItem à l’aide de l’objet IWSManEnumerator retourné jusqu’à ce que la fin des éléments soit indiquée par la propriété AtEndOfStream .
N’oubliez pas que si les indicateurs incluent les constantes d’énumérationWSManFlagHierarchyDeepBasePropsOnly ou WSManFlagHierarchyShallow , le service Gestion à distance Windows retourne le code d’erreur ERROR_WSMAN_POLYMORPHISM_MODE_UNSUPPORTED.
Pour plus d’informations sur la limitation des appels réseau pendant une énumération, consultez la propriété BatchItems .
Si un filtre est spécifié, il doit s’agir d’un document valide en ce qui concerne le schéma de la ressource. Le paramètre dialecte est facultatif. Toutefois, si la chaîne de filtre commence <par , mais n’est pas un fragment XML, incluez le paramètre dialecte ou définissez l’indicateur WSManFlagNonXmlText dans le paramètre flags . Pour plus d’informations, consultez Constantes d’énumération.
La méthode de script correspondante est Session.Enumerate.
Configuration requise
Condition requise | Valeur |
---|---|
Client minimal pris en charge | Windows Vista |
Serveur minimal pris en charge | Windows Server 2008 |
Plateforme cible | Windows |
En-tête | wsmandisp.h |
Bibliothèque | WSManDisp.tlb |
DLL | WSMAuto.dll |