PowerShell Cmdlet - ConvertTo-XML
 記事記号:[mf1926] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    ConvertTo-XML
    
概要
    オブジェクトの表記を XML ベースで作成します。
    
構文
    ConvertTo-XML [-InputObject] <psobject> [-As <string>] [-Depth <int>] [-NoTy
    peInformation] [<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 PowerS
    hell で処理を続行できます。
    
パラメーター
    -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 [<SwitchParameter>]
        オブジェクト ノードから型属性を省略します。
        
        必須                         false
        位置                         named
        既定値                       False
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help 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 のレベルま
    で展開されます。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=135204
    Export-Clixml 
    Import-Clixml 
    ConvertTo-Html 
    ConvertTo-Csv 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、ConvertTo-XML
ご利用数: 1858239
感想・要望・問い合わせは こちら