Updates the formatting data in the current session.
Syntax
 Copy Code |
|
|---|---|
Update-FormatData [[-AppendPath] <string[]>] [-PrependPath <string[]>] [-Confirm] [-WhatIf] [<CommonParameters>] |
|
Description
The Update-FormatData cmdlet reloads the formatting data from formatting files into the current session. This cmdlet lets you update the formatting data without restarting Windows PowerShell.
Without parameters, Update-FormatData reloads the formatting files that it loaded previously. You can use the parameters of Update-FormatData to add new formatting files to the session.
Formatting files are text files in XML format with the format.ps1xml file name extension. The formatting data in the files defines the display of Microsoft .NET Framework objects in the session.
When Windows PowerShell starts, it loads the format data from the formatting files in the Windows PowerShell installation directory ($pshome) into the session. You can use Update-FormatData to reload the formatting data into the current session without restarting Windows PowerShell. This is useful when you have added or changed a formatting file, but do not want to interrupt the session.
For more information about formatting files in Windows PowerShell, see about_Format.ps1xml.
Parameters
-AppendPath <string[]>
Adds the specified formatting files to the session. The files are loaded after Windows PowerShell loads the built-in formatting files.
When formatting .NET objects, Windows PowerShell uses the first formatting definition that it finds for each .NET type. If you use the AppendPath parameter, Windows PowerShell searches the data from the built-in files before it encounters the formatting data that you are adding.
Use this parameter to add a file that formats a .NET object that is not referenced in the built-in formatting files.
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
|
Accept Wildcard Characters? |
false |
-PrependPath <string[]>
Adds the specified formatting files to the session. The files are loaded before Windows PowerShell loads the built-in formatting files.
When formatting .NET objects, Windows PowerShell uses the first formatting definition that it finds for each .NET type. If you use the PrependPath parameter, Windows PowerShell searches the data from the files that you are adding before it encounters the formatting data from the built-in files.
Use this parameter to add a file that formats a .NET object that is also referenced in the built-in formatting files.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
<CommonParameters>
This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.
Inputs and Outputs
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.
|
Inputs |
System.String You can pipe a string that contains the append path to Update-FormatData. |
|
Outputs |
None The cmdlet does not return any output. |
Notes
Update-FormatData also updates the formatting data for commands in the session that were imported from modules. If the formatting file for a module changes, you can run an Update-FormatData command to update the formatting data for imported commands. You do not need to import the module again.
Example 1
| Copy Code |
|
|---|---|
C:\PS>update-formatdata |
|
Description
-----------
This command reloads the formatting files that it loaded previously.
Example 2
| Copy Code |
|
|---|---|
C:\PS>update-formatdata -appendpath trace.format.ps1xml, log.format.ps1xml |
|
Description
-----------
This command reloads the formatting files into the session, including two new files, Trace.format.ps1xml and Log.format.ps1xml.
Because the command uses the AppendPath parameter, the formatting data in the new files is loaded after the formatting data from the built-in files.
The AppendPath parameter is used because the new files contain formatting data for objects that are not referenced in the built-in files.
Example 3
| Copy Code |
|
|---|---|
C:\PS>update-formatdata -prependPath c:\test\NewFiles.format.ps1xml # Edit the NewFiles.format.ps1 file. C:\PS> update-formatdata |
|
Description
-----------
This example shows how to reload a formatting file after you have edited it.
The first command adds the NewFiles.format.ps1xml file to the session. It uses the PrependPath parameter because the file contains formatting data for objects that are referenced in the built-in files.
After adding the NewFiles.format.ps1xml file and testing it in these session, the author edits the file.
The second command uses the Update-FormatData cmdlet to reload the formatting files. Because the NewFiles.format.ps1xml file was previously loaded, Update-FormatData automatically reloads it without using parameters.