オブジェクトの表記を XML ベースで作成します。
構文
ConvertTo-XML [-InputObject] <psobject> [-As <string>] [-Depth <int>] [-NoTypeInformation] [<CommonParameters>]
説明
ConvertTo-Xml コマンドレットは 1 つ以上の Microsoft .NET Framework オブジェクトの表記を XML ベースで作成します。このコマンドレットを使用するには、1 つ以上のオブジェクトをコマンドレットにパイプするか、InputObject パラメーターを使用してオブジェクトを指定します。
複数のオブジェクトを ConvertTo-XML にパイプするか、InputObject パラメーターを使用して複数のオブジェクトを送信すると、すべてのオブジェクトの表記を含む XML ドキュメントが 1 つ ConvertTo-XML から返されます。
このコマンドレットは Export-Clixml に似ていますが、Export-Clixml は結果の XML をファイルに保存します。ConvertTo-XML は XML を返すので、Windows PowerShell で処理を続行できます。
パラメーター
-As <string>
出力形式を決定します。有効な値は次のとおりです。
-- String: 文字列を 1 つ返します。
-- Stream: 文字列の配列を返します。
-- Document: XmlDocument オブジェクトを返します。
既定値は Stream です。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
Stream |
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-Depth <int>
XML 表記に含めるオブジェクトのレベル数を指定します。既定値は 1 です。
たとえば、オブジェクトのプロパティにオブジェクトも含まれている場合、含まれているオブジェクトのプロパティの XML 表記を保存するには、深さを 2 と指定する必要があります。
オブジェクトの型の既定値は Types.ps1xml ファイルで上書きできます。詳細については、「about_Types.ps1xml」を参照してください。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
1 |
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-InputObject <psobject>
変換するオブジェクトを指定します。オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。パイプを使用してオブジェクトを ConvertTo-XML に渡すこともできます。
|
必須 |
true |
|
位置 |
1 |
|
既定値 |
なし |
|
パイプライン入力を許可する |
true (ByValue) |
|
ワイルドカード文字を許可する |
true |
-NoTypeInformation
オブジェクト ノードから型属性を省略します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
False |
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
|
入力 |
System.Management.Automation.PSObject パイプを使用してあらゆるオブジェクトを ConvertTo-XML に渡すことができます。 |
|
出力 |
System.String または System.Xml.XmlDocument ConvertTo-XML から返されるオブジェクトの型は、As パラメーターの値によって決まります。 |
例 1
C:\PS>get-date | convertto-xml 説明 ----------- このコマンドは、現在の日付 (DateTime オブジェクト) を XML に変換します。
例 2
C:\PS>convertto-xml -as Document -inputObject (get-process) -depth 3 説明 ----------- このコマンドはコンピューターで実行しているすべてのプロセスを表すプロセス オブジェクトを XML ドキュメントに変換します。オブジェクトは深さ 3 のレベルまで展開されます。
関連項目