.png)
Export-Clixml
Published: February 29, 2012
Updated: August 15, 2012
Applies To: Windows PowerShell 2.0, Windows PowerShell 3.0
Export-Clixml
Syntax
Parameter Set: ByPath Export-Clixml [-Path] <String> -InputObject <PSObject> [-Depth <Int32> ] [-Encoding <String> ] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: ByLiteralPath Export-Clixml -InputObject <PSObject> -LiteralPath <String> [-Depth <Int32> ] [-Encoding <String> ] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Export-Clixml cmdlet creates an XML-based representation of an object or objects and stores it in a file. You can then use the Import-CLIXML cmdlet to re-create the saved object based on the contents of that file.
This cmdlet is similar to ConvertTo-XML, except that Export-Clixml stores the resulting XML in a file. ConvertTo-XML returns the XML, so you can continue to process it in Windows PowerShell.
Parameters
-Depth<Int32>
Specifies how many levels of contained objects are included in the XML representation. The default value is 2.
The default value can be overridden for the object type in the Types.ps1xml files. For more information, see about_Types.ps1xml.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
2 |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Encoding<String>
Specifies the type of encoding for the target file. Valid values are ASCII, UTF8, UTF7, UTF32, Unicode, BigEndianUnicode, Default, and OEM. Unicode is the default.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
Unicode |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Force
Causes the cmdlet to clear the read-only attribute of the output file if necessary. The cmdlet will attempt to reset the read-only attribute when the command completes.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
False |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-InputObject<PSObject>
Specifies the object to be converted. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe objects to Export-Clixml.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-NoClobber
Ensures that the cmdlet does not overwrite the contents of an existing file. By default, if a file exists in the specified path, Export-Clixml overwrites the file without warning.
|
Aliases |
NoOverwrite |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
False |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Path<String>
Specifies the path to the file where the XML representation of the object will be stored.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-LiteralPath<String>
Specifies the path to the file where the XML representation of the object will be stored. Unlike Path, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
false |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
false |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
System.Management.Automation.PSObject
You can pipe any object to Export-Clixml.
Outputs
The output type is the type of the objects that the cmdlet emits.
-
System.IO.FileInfo
Export-Clixml creates a file that contains the XML.
Examples
-------------------------- EXAMPLE 1 --------------------------
This command creates an XML file that stores a representation of the string, "This is a test".
PS C:\> "This is a test" | export-clixml sample.xml
-------------------------- EXAMPLE 2 --------------------------
This example shows how to export an object to an XML file and then create an object by importing the XML from the file.
The first command uses the Get-ACL cmdlet to get the security descriptor of the Test.txt file. It uses a pipeline operator to pass the security descriptor to Export-Clixml, which stores an XML-based representation of the object in a file named FileACL.xml.
The second command uses the Import-Clixml cmdlet to create an object from the XML in the FileACL.xml file. Then, it saves the object in the $FileAcl variable.
PS C:\> get-acl C:\test.txt | export-clixml -Path fileacl.xmlPS C:\>$fileacl = import-clixml fileacl.xml
Related topics
