Méthode SWbemServices.ReferencesTo

La méthode ReferencesTo de l’objet SWbemServices retourne toutes les classes ou instances d’association qui référencent une instance ou classe source spécifique. Cette méthode exécute la même fonction que la requête WQL REFERENCES OF.

Cette méthode est appelée en mode semi-synchronisé. 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 = .ReferencesTo( _
  ByVal strObjectPath, _
  [ ByVal strResultClass ], _
  [ ByVal strRole ], _
  [ ByVal bClassesOnly ], _
  [ ByVal bSchemaOnly ], _
  [ ByVal strRequiredQualifier ], _
  [ ByVal iFlags ], _
  [ ByVal objWbemNamedValueSet ] _
)

Paramètres

strObjectPath

Obligatoire. Chaîne qui contient le chemin d’accès de l’objet de la source pour cette méthode. Pour plus d’informations, consultez Description de l’emplacement d’un objet WMI.

strResultClass [optionnel]

Chaîne contenant un nom de classe. S’il est spécifié, ce paramètre indique que les objets d’association retournés doivent appartenir à la classe spécifiée dans ce paramètre ou en être dérivés.

strRole [facultatif]

Chaîne contenant le nom de la propriété. S’il est spécifié, ce paramètre indique que les objets d’association retournés doivent être limités à ceux dans lesquels l’objet source joue un rôle spécifique. 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 à la place des instances réelles des classes. Il s’agit des classes auxquelles appartiennent les objets d’association. La valeur par défaut de ce paramètre est FALSE.

bSchemaOnly [facultatif]

Valeur booléenne qui indique si la requête s’applique ou non au schéma et pas aux données. La valeur par défaut de ce paramètre est FALSE. Il ne peut être défini sur VRAI que si le paramètre strObjectPath spécifie le chemin d’objet d’une classe. Lorsque la valeur est VRAI, l'ensemble des points d'extrémité renvoyés représente les classes qui sont convenablement associées à la classe source dans le schéma.

strRequiredQualifier [optionnel]

Chaîne qui contient un nom de qualificateur. S’il est spécifié, ce paramètre indique que les objets d’association retournés doivent inclure le qualificateur spécifié.

iFlags [facultatif]

Entier qui spécifie des indicateurs supplémentaires pour 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))

Fait en sorte que Windows Management Instrumentation (WMI) conserve 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.

Valeur retournée

Si la méthode réussit, la méthode renvoie un objet SWbemObjectSet.

Codes d’erreur

Une fois la méthode ReferencesTo 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 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.

wbemFlagUseAmendedQualifiers - 131072 (0x20000)

Permet à WMI de retourner des données de modification de classe avec la définition de classe de base.

Notes

Pour plus d’informations sur la requête WQL associée REFERENCES OF, les instances sources et les objets d’association, consultez INSTRUCTION ASSOCIATORS OF.

Spécifications

Voir aussi

SWbemServices

SWbemObject.Associators_

SWbemObject.References_

SWbemServices.AssociatorsOf