This is the built-in help made by Microsoft for the command 'Export-FormatData', in PowerShell version 2 - as retrieved from
Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Saves formatting data from the current session in a formatting file.
Export-FormatData [-Force] [-IncludeScriptBlock] [-InputObject <ExtendedTypeDefinition[]>] [-NoClobber] [-Path <string>] [<CommonParameters>]
The Export-FormatData cmdlet creates Windows PowerShell formatting files (format.ps1xml) from the formatting objects in the current session. It t
akes 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 s
ession. You can view and edit the formatting files and use the Update-FormatData cmdlet to add the formatting data to a session.
For more information about formatting files in Windows PowerShell, see about_Format.ps1xml.
<
Online version: http://go.microsoft.com/fwlink/?LinkID=144302
Get-FormatData
Update-FormatData
<
-------------------------- 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 TypeName parameter directs the cmdle
t 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-FormatData cmdlet, which exports t
he 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 In
cludeScriptBlock 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 that the Get-Process cmdlet ret
urns. The command uses a pipeline operator (|) to send the formatting data to the Export-FormatData cmdlet, which exports it to the Process.forma
t.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 PrependPa
th parameter to ensure that the formatting data for process objects in the Process.format.ps1xml file is found before the standard formatting dat
a for process objects.
The third command shows the effects of this change. The command uses the Get-Process cmdlet to get processes that have names that begin with "P".
The output shows that property values that are calculated by using script blocks are missing from the display.