SWbemObjectEx.GetText_ メソッド

SWbemObjectEx オブジェクトの GetText_ メソッドは、オブジェクトまたはインスタンスの XML 表現を返します。 テキスト ファイルは、WbemObjectTextFormatEnum に示すように指定された XML 形式で書式設定されます。

この構文の説明については、スクリプト API のドキュメント規則に関するページを参照してください。

構文

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

パラメーター

iTextFormat [in]

必須。 結果の XML 形式を指定する WbemObjectTextFormatEnum の値。

iFlags [in、省略可能]

予約済み操作フラグ。 既定値は 0 (ゼロ) です。

objWbemNamedValueSet [in、省略可能]

操作のコンテキストを設定する SWbemNamedValueSet オブジェクト。 既定値は null です。 許可される名前と値のペアの詳細については、下記の「解説」を参照してください。

戻り値

このメソッドには戻り値がありません。

エラー コード

GetText_ メソッドの完了後、Err オブジェクトに次の一覧にあるいずれかのエラー コードが含まれる場合があります。

wbemErrFailed - 2147749889 (0x80041001)

未定義のエラーが発生しました。

wbemErrNotFound - 2147749890 (0x80041002)

要求された形式が見つかりませんでした。

wbemErrInvalidParameter - 2147749896 (0x80041008)

呼び出しに渡したパラメーターのいずれかが正しくありません。

wbemErrCriticalError - 2147749898 (0x8004100A)

予期しない重大な内部エラーが発生しました。 このエラーについては、Microsoft テクニカル サポートに連絡してください。

解説

SWbemNamedValueSet を構築する場合、次の名前と値のペアのみが許可されます。

名前
LocalOnly VT_BOOL
TRUE の場合、結果の XML にはローカルで定義されたプロパティとメソッドのみが存在します。 既定値は FALSE です。
IncludeQualifiers VT_BOOL
TRUE の場合、結果の XML にはクラス、インスタンス、プロパティ、およびメソッドの修飾子が含まれます。 既定値は FALSE です。
PathLevel VT-I4
既定値は 0 (ゼロ) です。 次のいずれかの値になります。
  • 0: <オブジェクトがクラスかインスタンスかに応じて、CLASS> 要素または <INSTANCE> 要素が作成されます。
  • 1: <値。NAMEDOBJECT> 要素が生成されます。
  • 2: >値。OBJECTWITHLOCALPATH> 要素が生成されます。
  • 3: >値。OBJECTWITHPATH> 要素が生成されます。
ExcludeSystemProperties VT-BOOL
TRUE の場合、__NAMESPACEなどのシステム プロパティは出力から除外されます。
IncludeClassOrigin VT_BOOL
TRUE の場合、クラスの生成元属性は PROPERTY> 要素と >METHOD> 要素に>設定されます。 既定値は FALSE です。

SWbemNamedValueSet の作成の詳細については、「SWbemNamedValueSet.Add」を参照してください。

次のスクリプトは、Win32_Bios クラス定義の XML 表現を取得する方法を示しています。 Win32_Bios の特定のインスタンスを指定することで、そのオブジェクトのデータを 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

要件

要件
サポートされている最小のクライアント
Windows Vista
サポートされている最小のサーバー
Windows Server 2008
Header
Wbemdisp.h
タイプ ライブラリ
Wbemdisp.tlb
[DLL]
Wbemdisp.dll
CLSID
CLSID_SWbemObjectEx
IID
IID_ISWbemObjectEx