Méthode SWbemObject.Associators_

Article
06/13/2023

La méthode Associators_ de l’objet SWbemObject retourne une collection d’objets (classes ou instances) associés à l’objet actuel. Ces objets retournés sont appelés points de terminaison. Cette méthode exécute la même fonction que la requête ASSOCIATORS OF WQL.

Pour obtenir une explication de cette syntaxe, consultez Conventions de document pour l’API de script.

Syntaxe

objWbemObjectSet = .Associators_( _
  [ ByVal strAssocClass ], _
  [ ByVal strResultClass ], _
  [ ByVal strResultRole ], _
  [ ByVal strRole ], _
  [ ByVal bClassesOnly ], _
  [ ByVal bSchemaOnly ], _
  [ ByVal strRequiredAssocQualifier ], _
  [ ByVal strRequiredQualifier ], _
  [ ByVal iFlags ], _
  [ ByVal objwbemNamedValueSet ] _
)

Paramètres

strAssocClass [in, 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 [in, facultatif]: Chaîne contenant un nom de classe. S’il est spécifié, ce paramètre 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 [in, 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 [in, 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 [in, 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 [in, facultatif]: Il s’agit d’une 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 l’objet sur lequel cette méthode est appelée est une classe. Lorsqu’il est défini sur TRUE, l’ensemble de points de terminaison retournés représente les classes qui sont correctement associées à la classe source dans le schéma.
strRequiredAssocQualifier [in, facultatif]: Chaîne contenant un nom de qualificateur. Ce paramètre, s’il est spécifié, indique que les points de terminaison retournés doivent être associés à l’objet source via une classe d’association qui inclut le qualificateur spécifié.
strRequiredQualifier [in, facultatif]: Chaîne contenant un nom de qualificateur. Ce paramètre, s’il est spécifié, indique que les points de terminaison retournés doivent inclure le qualificateur spécifié.
iFlags [in, facultatif]: Entier spécifiant des indicateurs supplémentaires à l’opération. La valeur par défaut de ce paramètre est wbemFlagReturnImmediately, qui indique à l’appel de retourner immédiatement plutôt que d’attendre que la requête soit terminée. 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.
wbemFlagUseAmendedQualifiers (131072 (0x20000)): Permet à WMI de retourner des données de modification de classe avec la définition de classe de base. L’inclusion de cet indicateur rend le texte du qualificateur de description localisée disponible pour les classes, les propriétés et les méthodes. Pour plus d’informations sur les qualificateurs modifiés, consultez Localisation des informations de classe WMI.

objwbemNamedValueSet [in, facultatif]

En règle générale, ceci 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 Associators_ terminée, l’objet Err peut contenir l’un des codes d’erreur de la liste suivante.

wbemErrAccessDenied - 2147749891 (0x80041003): L’utilisateur actuel n’a pas l’autorisation d’afficher une ou plusieurs des classes retournées par l’appel.
wbemErrFailed – 2147749889 (0x80041001): Erreur non spécifiée.
wbemErrInvalidParameter - 2147749896 (0x80041008): Un paramètre spécifié n’est pas valide.
wbemErrOutOfMemory - 2147749894: La mémoire disponible est insuffisante pour terminer cette opération.

Notes

Pour plus d’informations sur les requêtes, instances sources et points de terminaison WQL associés ASSOCIATORS OF, consultez INSTRUCTION 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	Wbemdisp.h
Bibliothèque de types	Wbemdisp.tlb
DLL	Wbemdisp.dll
CLSID	CLSID_SWbemObject
IID	IID_ISWbemObject

Voir aussi

SWbemObject
SWbemObject.References_
SWbemServices.AssociatorsOf
SWbemServices.ReferencesTo