Export-Clixml
1 つ以上のオブジェクトの表記を XML ベースで作成し、ファイルに保存します。
構文
Export-Clixml [-Path] <string> -InputObject <psobject> [-Depth <int>] [-Encoding <string>] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [<CommonParameters>]
説明
Export-Clixml コマンドレットは、オブジェクトの表記を XML ベースで作成してファイルに保存します。Import-CLIXML コマンドレットを使用すると、このファイルの内容に基づいて保存済みのオブジェクトを再作成することができます。
このコマンドレットは ConvertTo-XML に似ていますが、Export-Clixml は結果の XML をファイルに保存します。ConvertTo-XML は XML を返すので、Windows PowerShell で処理を続行できます。
パラメーター
-Depth <int>
XML 表記に含めるオブジェクトのレベル数を指定します。既定値は 2 です。
オブジェクトの型の既定値は Types.ps1xml ファイルで上書きできます。詳細については、「about_Types.ps1xml」を参照してください。
必須 |
false |
位置 |
named |
既定値 |
2 |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Encoding <string>
ターゲット ファイルのエンコードの種類を指定します。有効な値は、ASCII、UTF8、UTF7、UTF32、Unicode、BigEndianUnicode、Default、および OEM です。既定値は UTF8 です。
必須 |
false |
位置 |
named |
既定値 |
UTF8 |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Force
必要に応じて、出力ファイルの読み取り専用属性がクリアされます。このコマンドレットは、コマンドの完了時に読み取り専用属性の再設定を試みます。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-InputObject <psobject>
変換するオブジェクトを指定します。オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。パイプを使用してオブジェクトを Export-Clixml に渡すこともできます。
必須 |
true |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
true (ByValue) |
ワイルドカード文字を許可する |
false |
-NoClobber
コマンドレットが既存のファイルの内容を上書きできないようにします。既定では、指定したパスにファイルが存在する場合、Export-Clixml は警告なしにファイルを上書きします。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Path <string>
オブジェクトの XML 表記を保存するファイルのパスを指定します。
必須 |
true |
位置 |
1 |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドを実行する前に確認メッセージを表示します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
System.Management.Automation.PSObject パイプを使用して、あらゆるオブジェクトを Export-Clixml に渡すことができます。 |
出力 |
System.IO.FileInfo Export-Clixml は、XML を含むファイルを作成します。 |
例 1
C:\PS>"This is a test" | export-clixml sample.xml
説明
-----------
このコマンドは、"This is a test" という文字列の表記を保存する XML ファイルを作成します。
例 2
C:\PS>get-acl C:\test.txt | export-clixml -Path fileacl.xml
C:\PS> $fileacl = import-clixml fileacl.xml
説明
-----------
この例は、オブジェクトを XML ファイルにエクスポートし、そのファイルから XML をインポートしてオブジェクトを作成する方法を示しています。
最初のコマンドは、Get-ACL コマンドレットを使用して Test.txt ファイルのセキュリティ記述子を取得します。また、パイプライン演算子を使用してセキュリティ記述子を Export-Clixml に渡します。Export-Clixml はオブジェクトの XML ベースの表記を FileACL.xml という名前のファイルに保存します。
2 番目のコマンドは、Import-Clixml コマンドレットを使用して、FileACL.xml ファイルの XML からオブジェクトを作成します。次に、そのオブジェクトを $FileAcl 変数に保存します。