powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Export-FormatData



NAME
Export-FormatData

SYNOPSIS
Saves formatting data from the current session in a formatting file.

SYNTAX
Export-FormatData [-Force] [-IncludeScriptBlock] [-InputObject ] [-NoClobber] [-Path ing>] []


DESCRIPTION
The Export-FormatData cmdlet creates Windows PowerShell formatting files (format.ps1xml) from the formatting object
s in the current session. It takes the ExtendedTypeDefinition objects that Get-FormatData returns and saves them in
a file in XML format.

Windows PowerShell uses the data in formatting files (format.ps1xml) to generate the default display of Microsoft .
NET Framework objects in the session. You can view and edit the formatting files and use the Update-FormatData cmdl
et to add the formatting data to a session.

For more information about formatting files in Windows PowerShell, see about_Format.ps1xml.


PARAMETERS
-Force []
Overwrites an existing output file, even if the file has the read-only attribute.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-IncludeScriptBlock []
Determines whether script blocks in the format data are exported.

Because script blocks contain code and can be used maliciously, they are not exported by default.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-InputObject
Specifies the format data objects to be exported. Enter a variable that contains the objects or a command that
gets the objects, such as a Get-FormatData command. You can also pipe the objects from Get-FormatData to Export
-FormatData.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-NoClobber []
Prevents the cmdlet from overwriting existing files. By default, Export-FormatData overwrites files without war
ning unless the file has the read-only attribute.

To direct Export-FormatData to overwrite read-only files, use the Force parameter.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Path
Specifies a location for the output file. Enter a path (optional) and file name with a format.ps1xml file name
extension. If you omit the path, Export-FormatData creates the file in the current directory.

If you use a file name extension other than .ps1xml, the Update-FormatData cmdlet will not recognize the file.

If you specify an existing file, Export-FormatData overwrites the file without warning, unless the file has the
read-only attribute. To overwrite a read-only file, use the Force parameter. To prevent files from being overw
ritten, use the NoClobber parameter.

Required? false
Position? named
Default value None
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.Management.Automation.ExtendedTypeDefinition
You can pipe ExtendedTypeDefinition objects from Get-FormatData to Export-FormatData.


OUTPUTS
None
Export-FormatData does not return any objects. It generates a file and saves it in the specified path.


NOTES


To use any formatting file, including an exported formatting file, the execution policy for the session must al
low scripts and configuration files to run. For more information, see about_Execution_Policies.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>get-formatdata -typename * | export-formatdata -path allformat.ps1xml -IncludeScriptBlock


Description
-----------
This command exports all of the format data in the session to the AllFormat.ps1xml file.

The command uses the Get-FormatData cmdlet to get the format data in the session. A value of * (all) for the TypeNa
me parameter directs the cmdlet to get all of the data in the session.

The command uses a pipeline operator (|) to send the format data from the Get-FormatData command to the Export-Form
atData cmdlet, which exports the format data to the AllFormat.ps1 file.

The Export-FormatData command uses the IncludeScriptBlock parameter to include script blocks in the format data in
the file.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>$f = get-formatdata -typename helpinfoshort

C:\PS> export-formatdata -inputObject $f -path c:\test\help.format.ps1xml -IncludeScriptBlock


Description
-----------
These commands export the format data for the HelpInfoShort type to the Help.format.ps1xml file.

The first command uses the Get-FormatData cmdlet to get the format data for the HelpInfoShort type, and it saves it
in the $f variable.

The second command uses the InputObject parameter of the Export-FormatData to enter the format data saved in the $f
variable. It also uses the IncludeScriptBlock parameter to include script blocks in the output.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>get-formatdata -typename System.Diagnostics.Process | export-FormatData -path process.format.ps1xml

C:\PS> Update-FormatData -prependPath .\process.format.ps1xml

C:\PS> get-process p*

Handles NPM(K) PM(K) WS(K) VM(M) CPU(s) Id ProcessName
------- ------ ----- ----- ----- ------ -- -----------
323 5600 powershell
336 3900 powershell_ise
138 4076 PresentationFontCache


Description
-----------
This example shows the effect of omitting the IncludeScriptBlock parameter from an Export-FormatData command.

The first command uses the Get-FormatData cmdlet to get the format data for the System.Diagnostics.Process object t
hat the Get-Process cmdlet returns. The command uses a pipeline operator (|) to send the formatting data to the Exp
ort-FormatData cmdlet, which exports it to the Process.format.ps1xml file in the current directory.

In this case, the Export-FormatData command does not use the IncludeScriptBlock parameter.

The second command uses the Update-FormatData cmdlet to add the Process.format.ps1xml file to the current session.
The command uses the PrependPath parameter to ensure that the formatting data for process objects in the Process.fo
rmat.ps1xml file is found before the standard formatting data for process objects.

The third command shows the effects of this change. The command uses the Get-Process cmdlet to get processes that h
ave names that begin with "P". The output shows that property values that are calculated by using script blocks are
missing from the display.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=144302
Get-FormatData
Update-FormatData