IWbemObjectTextSrc ::GetText, méthode (wbemcli.h)

La méthode IWbemObjectTextSrc ::GetText crée une représentation textuelle d’un objet IWbemClassObject ; par exemple, une représentation XML.

Syntaxe

HRESULT GetText(
  long             lFlags,
  IWbemClassObject *pObj,
  ULONG            uObjTextFormat,
  IWbemContext     *pCtx,
  BSTR             *strText
);

Paramètres

lFlags

Réservé. Doit être de 0L.

pObj

Référence à l’objet à représenter au format texte. Ce paramètre ne peut pas être NULL.

uObjTextFormat

Définition du format de texte utilisé pour représenter l’objet. Pour plus d’informations sur les valeurs valides pour ce paramètre, consultez Remarques.

WMI_OBJ_TEXT_CIM_DTD_2_0 (1 (0x1))

Utilisez le DTD qui correspond à CIM DTD version 2.0.

WMI_OBJ_TEXT_WMI_DTD_2_0 (2 (0x2))

Utilisez le DTD WMI qui correspond à CIM DTD version 2.0. L’utilisation de cette valeur active les extensions spécifiques à WMI, telles que les objets incorporés ou l’étendue.

WMI_OBJ_TEXT_WMI_EXT1 (3 (0x3))

Réservé pour un usage futur.

WMI_OBJ_TEXT_WMI_EXT2 (4 (0x4))

Réservé pour un usage futur.

WMI_OBJ_TEXT_WMI_EXT3 (5 (0x5))

Réservé pour un usage futur.

WMI_OBJ_TEXT_WMI_EXT4 (6 (0x6))

Réservé pour un usage futur.

WMI_OBJ_TEXT_WMI_EXT5 (7 (0x7))

Réservé pour un usage futur.

WMI_OBJ_TEXT_WMI_EXT6 (8 (0x8))

Réservé pour un usage futur.

WMI_OBJ_TEXT_WMI_EXT7 (9 (0x9))

Réservé pour un usage futur.

WMI_OBJ_TEXT_WMI_EXT8 (10 (0xA))

Réservé pour un usage futur.

WMI_OBJ_TEXT_WMI_EXT9 (11 (0xB))

Réservé pour un usage futur.

WMI_OBJ_TEXT_WMI_EXT10 (12 (0xC))

Réservé pour un usage futur.

WMI_OBJ_TEXT_LAST (13 (0xD))

Réservé pour un usage futur.

pCtx

facultatif. Objet de contexte pour l’opération. L’objet de contexte peut être utilisé pour spécifier si certaines parties de l’objet sont représentées dans du texte ; par exemple, si des qualificateurs doivent être inclus dans la représentation textuelle. L’objet de contexte prend les valeurs facultatives suivantes.

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 des classes, instances, propriétés et méthodes sont inclus dans la sortie. 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, comme __NAMESPACE, sont absentes dans la sortie. La valeur par défaut est FALSE.

IncludeClassOrigin (VT_BOOL)

Si la valeur est TRUE, l’attribut d’origine de la classe est défini sur les éléments PROPERTY et METHOD . La valeur par défaut est FALSE.

strText

Représentation textuelle de l’objet. L’utilisateur doit libérer la chaîne à l’aide de SysFreeString quand il a terminé avec strText.

Valeur retournée

Cette méthode retourne une valeur HRESULT qui indique l’état de l’appel de méthode. La liste suivante répertorie la valeur contenue dans un HRESULT.

Remarques

Pour plus d’informations, consultez Représentation d’objets en XML.

Configuration requise