SWbemObject.References_ méthode

Article
06/29/2023

La méthode References_ de l’objet SWbemObject retourne une collection de toutes les classes d’association ou instances qui font référence à l’objet actuel.

Cette méthode exécute la même fonction que la requête REFERENCES OF WQL.

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

Syntaxe

objWbemObjectSet = .References_( _
  [ ByVal strResultClass ], _
  [ ByVal strRole ], _
  [ ByVal bClassesOnly ], _
  [ ByVal bSchemaOnly ], _
  [ ByVal strRequiredQualifier ], _
  [ ByVal iFlags ], _
  [ ByVal objwbemNamedValueSet ] _
)

Paramètres

strResultClass [in, facultatif]: Chaîne qui contient un nom de classe. S'il est spécifié, ce paramètre indique que les objets d'association renvoyés doivent appartenir à la classe spécifiée dans ce paramètre ou en être dérivés.
strRole [in, 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 [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 objets d’association. La valeur par défaut de ce paramètre est FALSE.
bSchemaOnly [in, facultatif]: Valeur booléenne indiquant 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. Lorsque la valeur est TRUE, 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 [in, facultatif]: 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 [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)): 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.
wbemFlagUseAmendedQualifiers (131072 (0x20000)): Permet à WMI de retourner des données de modification de classe avec la définition de classe de base. 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 References_ 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 non valide a été spécifié.
wbemErrOutOfMemory - 2147749894 (0x80041006): La mémoire disponible est insuffisante pour terminer cette opération.

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

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.Associators_
SWbemServices.AssociatorsOf
SWbemServices.ReferencesTo

Partager via