Méthode SWbemServices.AssociatorsOf
La méthode AssociatorsOf de l’objet SWbemServices renvoie une collection d’objets (classes ou instances) appelés points de terminaison associés à un objet spécifié. Cette méthode exécute la même fonction que la requête ASSOCIATORS OF WQL.
Cette méthode est appelée en mode semi-synchronisé par défaut. Pour plus d’informations, consultez Appel d’une méthode.
Pour obtenir une explication de cette syntaxe, consultez Conventions de document pour l’API de script.
Syntaxe
objWbemObjectSet = .AssociatorsOf( _
ByVal strObjectPath, _
[ ByVal strAssocClass ], _
[ ByVal strResultClass ], _
[ ByVal strResultRole ], _
[ ByVal strRole ], _
[ ByVal bClassesOnly ], _
[ ByVal bSchemaOnly ], _
[ ByVal strRequiredAssocQualifier ], _
[ ByVal strRequiredQualifier ], _
[ ByVal iFlags ], _
[ ByVal objwbemNamedValueSet ] _
)
Paramètres
-
strObjectPath
-
Obligatoire. Chaîne contenant le chemin d’accès à l’objet de la classe ou à l’instance source. Pour plus d’informations, consultez Description de l’emplacement d’un objet WMI.
-
strAssocClass [facultatif]
-
Chaîne contenant une classe d’association. S’il est spécifié, ce paramètre indique que les points de terminaison retournés doivent être associés à la source via la classe d’association spécifiée ou une classe dérivée de cette classe d’association.
-
strResultClass [facultatif]
-
Chaîne contenant un nom de classe. S’il est spécifié, ce paramètre facultatif indique que les points de terminaison retournés doivent appartenir ou être dérivés de la classe spécifiée dans ce paramètre.
-
strResultRole [facultatif]
-
Chaîne contenant le nom de la propriété. S’il est spécifié, ce paramètre indique que les points de terminaison retournés doivent jouer un rôle particulier dans leur association à l’objet source. Le rôle est défini par le nom d’une propriété spécifiée (qui doit être une propriété de référence) d’une association.
-
strRole [facultatif]
-
Chaîne contenant le nom de la propriété. S’il est spécifié, ce paramètre indique que les points de terminaison retournés doivent participer à une association avec l’objet source dans lequel l’objet source joue un rôle particulier. Le rôle est défini par le nom d’une propriété spécifiée (qui doit être une propriété de référence) d’une association.
-
bClassesOnly [facultatif]
-
Valeur booléenne qui indique si une liste de noms de classes doit être retournée plutôt que des instances réelles des classes. Il s’agit des classes auxquelles appartiennent les instances de points de terminaisons. La valeur par défaut de ce paramètre est FALSE.
-
bSchemaOnly [facultatif]
-
Valeur booléenne qui indique si la requête s’applique au schéma plutôt qu’aux données. La valeur par défaut de ce paramètre est FALSE. Elle ne peut être définie sur TRUE que si le paramètre strObjectPath spécifie le chemin d’objet d’une classe. Lorsqu’il est défini sur TRUE, l’ensemble des points de terminaison retournés représente les classes qui sont correctement associées à la classe source dans le schéma.
-
strRequiredAssocQualifier [facultatif]
-
Chaîne contenant un nom de qualificateur. S’il est spécifié, ce paramètre indique que les points de terminaison retournés doivent être associés à l’objet source via une classe d’association incluant le qualificateur spécifié.
-
strRequiredQualifier [facultatif]
-
Chaîne contenant un nom de qualificateur. S’il est spécifié, ce paramètre indique que les points de terminaison retournés doivent inclure le qualificateur spécifié.
-
iFlags [facultatif]
-
Entier spécifiant des indicateurs supplémentaires pour l’opération. La valeur par défaut de ce paramètre est wbemFlagReturnImmediately, qui appelle la méthode en mode semi-synchrone. Ce paramètre peut accepter les valeurs suivantes.
-
wbemFlagForwardOnly (32 (0x20))
-
Provoque le retour d’un énumérateur uniquement vers l’avant. Les énumérateurs de ce type sont généralement beaucoup plus rapides et utilisent moins de mémoire que les énumérateurs conventionnels, mais ils ne permettent pas les appels à SWbemObject.Clone_.
-
wbemFlagBidirectional (0 (0x0))
-
Permet à WMI de conserver les pointeurs vers les objets de l’énumération jusqu’à ce que le client libère l’énumérateur.
-
wbemFlagReturnImmediately (16 (0x10))
-
Provoque le retour immédiat de l’appel.
-
wbemFlagReturnWhenComplete (0 (0x0))
-
Provoque le blocage de cet appel jusqu’à ce que la requête soit terminée. Cet indicateur appelle la méthode en mode synchrone.
-
wbemFlagUseAmendedQualifiers (131072 (0x20000))
-
Amène WMI à retourner les données de modification de classe avec la définition de classe de base. Pour plus d’informations, consultez Localisation des informations de classe WMI.
objwbemNamedValueSet [facultatif]
En règle générale, ce n’est pas défini. Sinon, il s’agit d’un objet SWbemNamedValueSet dont les éléments représentent les informations de contexte qui peuvent être utilisées par le fournisseur répondant à la demande. Un fournisseur qui prend en charge ou requiert de telles informations doit documenter les noms de valeur reconnus, le type de données de la valeur, les valeurs autorisées et la sémantique.
Valeur retournée
Si l’appel réussit, un objet SWbemObjectSet est retourné.
Codes d’erreur
Une fois la méthode AssociatorsOf terminée, l’objet Err peut contenir l’un des codes d’erreur de la liste suivante.
Notes
Une collection retournée qui ne contient aucun élément n’est pas une erreur.
-
wbemErrAccessDenied - 2147749891 (0x80041003)
-
L’utilisateur actuel n’a pas l’autorisation de voir une ou plusieurs des classes retournées par l’appel.
-
wbemErrFailed – 2147749889 (0x80041001)
-
Erreur non spécifiée.
-
wbemErrInvalidParameter - 2147749896 (0x80041008)
-
Un paramètre non valide a été spécifié.
-
wbemErrOutOfMemory - 2147749894 (0x80041006)
-
La mémoire disponible est insuffisante pour terminer cette opération.
-
wbemErrNotFound - 2147749890 (0x80041002)
-
L’élément demandé est introuvable.
Notes
La méthode permet de récupérer les instances de ressources gérées qui sont associées à une ressource spécifiée par le biais d'une ou plusieurs classes d'association. Vous fournissez le chemin d’accès de l’objet pour le point de terminaison d’origine, et AssociatorsOf retourne les ressources gérées au point de terminaison opposé. La méthode AssociatorsOf exécute la même fonction que la requête ASSOCIATORS OF WQL.
Pour plus d’informations sur les requêtes, instances sources et points de terminaison WQL associés à ASSOCIATORS OF, consultez Instructions ASSOCIATORS OF.
Spécifications
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge |
Windows Vista |
| Serveur minimal pris en charge |
Windows Server 2008 |
| En-tête |
|
| Bibliothèque de types |
|
| DLL |
|
| CLSID |
CLSID_SWbemServices |
| IID |
IID_ISWbemServices |