Méthode SWbemObjectEx.GetText_

Article
07/14/2023

La méthode GetText_ de l’objet SWbemObjectEx renvoie une représentation XML d’un objet ou d’une instance. Le fichier texte est mis en forme au format XML spécifié, comme indiqué dans WbemObjectTextFormatEnum.

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

Syntaxe

strObj = .GetText_( _
  ByVal iTextFormat, _
  [ ByVal iFlags ], _
  [ ByVal objWbemNamedValueSet ] _
)

Paramètres

iTextFormat [in]: Obligatoire. Une valeur de WbemObjectTextFormatEnum qui spécifie le format XML résultant.
iFlags [in, facultatif]: Indicateurs d’opération réservée. La valeur par défaut est 0 (zéro).
objWbemNamedValueSet [in, facultatif]: Un objet SWbemNamedValueSet qui définit le contexte de l’opération. La valeur par défaut est null. Pour plus d’informations sur les paires nom/valeur autorisées, voir Remarques ci-dessous.

Valeur retournée

Cette méthode n’a aucune valeur de retour.

Codes d’erreur

Une fois la méthode GetText_ terminée, l’objet Err peut contenir l’un des codes d’erreur de la liste suivante.

wbemErrFailed - 2147749889 (0x80041001): Erreur non spécifiée.
wbemErrNotFound - 2147749890 (0x80041002): Le format demandé est introuvable.
wbemErrInvalidParameter - 2147749896 (0x80041008): Un des paramètres de l'appel n'est pas correct.
wbemErrCriticalError - 2147749898 (0x8004100A): Une erreur interne, critique et inattendue est survenue. Signalez cette erreur au Support technique Microsoft.

Notes

Lors de la construction de votre SWbemNamedValueSet, seules les paires nom/valeur suivantes sont autorisées.

Nom	Valeur
LocalOnly	VT_BOOL Si la valeur est TRUE, seules les propriétés et méthodes définies localement sont présentes dans le fichier XML résultant. La valeur par défaut est FALSE.
IncludeQualifiers	VT_BOOL Si la valeur est TRUE, les qualificateurs de classes, d’instances, de propriétés et de méthodes sont inclus dans le code XML résultant. La valeur par défaut est FALSE.
PathLevel	VT-I4 La valeur par défaut est 0 (zéro). Les valeurs possibles sont les suivantes : 0 : Un <élément CLASS> ou <INSTANCE> est créé selon que l’objet est une classe ou un instance. 1 : VALEUR <. L’élément NAMEDOBJECT> est généré. 2 : VALEUR >. L’élément OBJECTWITHLOCALPATH> est généré. 3 : VALEUR >. L’élément OBJECTWITHPATH> est généré.
ExcludeSystemProperties	VT-BOOL Si la valeur est TRUE, les propriétés système, telles que __NAMESPACE, sont exclues de la sortie.
IncludeClassOrigin	VT_BOOL Si la valeur est TRUE, l’attribut d’origine de classe est défini sur les >éléments PROPERTY> et >METHOD> . La valeur par défaut est FALSE.

Pour plus d’informations sur la création d’un SWbemNamedValueSet, voir SWbemNamedValueSet.Add.

Exemples

Le script suivant montre comment obtenir une représentation XML de la définition de classe Win32_Bios. En spécifiant une instance particulière de Win32_Bios, vous pouvez obtenir les données de cet objet en XML.

' Connect to the default namespace (root\cimv2) with the default
' impersonation level ("impersonate") and obtain a Win32_Bios class
' object.
Set obj = GetObject("winmgmts:win32_bios")

' Use the value for the desired XML CIM DTD format. 
XMLDtd = 1
Text = obj.GetText_(XMLDtd)
wscript.echo Text

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_SWbemObjectEx
IID	IID_ISWbemObjectEx

Partager via