IWbemObjectTextSrc::GetText メソッド (wbemcli.h)

IWbemObjectTextSrc::GetText メソッドは、IWbemClassObject オブジェクトのテキスト表現を作成します。たとえば、XML 表現です。

構文

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

パラメーター

lFlags

予約済み。 0L にする必要があります。

pObj

テキスト形式で表されるオブジェクトへの参照。 このパラメーターを NULL にすることはできません。

uObjTextFormat

オブジェクトを表すために使用されるテキスト形式の定義。 このパラメーターの有効な値の詳細については、「解説」を参照してください。

WMI_OBJ_TEXT_CIM_DTD_2_0 (1 (0x1))

CIM DTD バージョン 2.0 に対応する DTD を使用します。

WMI_OBJ_TEXT_WMI_DTD_2_0 (2 (0x2))

CIM DTD バージョン 2.0 に対応する WMI DTD を使用します。 この値を使用すると、埋め込みオブジェクトやスコープなどの WMI 固有の拡張機能が有効になります。

WMI_OBJ_TEXT_WMI_EXT1 (3 (0x3))

将来利用するために予約されています。

WMI_OBJ_TEXT_WMI_EXT2 (4 (0x4))

将来利用するために予約されています。

WMI_OBJ_TEXT_WMI_EXT3 (5 (0x5))

将来利用するために予約されています。

WMI_OBJ_TEXT_WMI_EXT4 (6 (0x6))

将来利用するために予約されています。

WMI_OBJ_TEXT_WMI_EXT5 (7 (0x7))

将来利用するために予約されています。

WMI_OBJ_TEXT_WMI_EXT6 (8 (0x8))

将来利用するために予約されています。

WMI_OBJ_TEXT_WMI_EXT7 (9 (0x9))

将来利用するために予約されています。

WMI_OBJ_TEXT_WMI_EXT8 (10 (0xA))

将来利用するために予約されています。

WMI_OBJ_TEXT_WMI_EXT9 (11 (0xB))

将来利用するために予約されています。

WMI_OBJ_TEXT_WMI_EXT10 (12 (0xC))

将来利用するために予約されています。

WMI_OBJ_TEXT_LAST (13 (0xD))

将来利用するために予約されています。

pCtx

省略可能。 操作のコンテキスト オブジェクト。 コンテキスト オブジェクトを使用して、オブジェクトの特定の部分をテキストで表すかどうかを指定できます。たとえば、テキスト表現に修飾子を含めるかどうかなどです。 コンテキスト オブジェクトは、次の省略可能な値を受け取ります。

LocalOnly (VT_BOOL)

TRUE の場合、結果の XML にはローカルで定義されたプロパティとメソッドのみが存在します。 既定値は FALSE です。

IncludeQualifiers (VT_BOOL)

TRUE の場合、クラス、インスタンス、プロパティ、およびメソッドの修飾子が出力に含まれます。 既定値は FALSE です。

PathLevel (VT_I4)

既定値は 0 (ゼロ) です。

次のいずれかの値になります。

• 0

  CLASS 要素または INSTANCE 要素は、オブジェクトがクラスかインスタンスかに応じて作成されます。

• 1

  VALUE。NAMEDOBJECT 要素が生成されます。

• 2

  VALUE。OBJECTWITHLOCALPATH 要素が生成されます。

• 3

  VALUE。OBJECTWITHPATH 要素が生成されます。

ExcludeSystemProperties (VT_BOOL)

TRUE の場合、__NAMESPACEなどのシステム プロパティは出力に存在しません。 既定値は FALSE です。

IncludeClassOrigin (VT_BOOL)

TRUE の場合、PROPERTY 要素とMETHOD 要素に対してクラスの配信元属性が設定されます。 既定値は FALSE です。

strText

オブジェクトのテキスト表現。 strText で終了したら、SysFreeString を使用して文字列を解放する必要があります。

戻り値

このメソッドは、メソッド呼び出しの状態を示す HRESULT を返します。 次の一覧は、 HRESULT に含まれる値の一覧です。

注釈

詳細については、「 XML でのオブジェクトの表し方」を参照してください。

要件