Update-FormatData

 

SYNOPSIS

Updates and appends format data files.

 

SYNTAX

Update-FormatData [[-appendPath] <string[]>] [-prependPath <string[]>] [<CommonParameters>]

 

DETAILED DESCRIPTION

The Windows PowerShell directory contains several format files. They have the file extension .ps1xml and are text files in XML format. When the shell starts, it reads the format data from those files. You can build your own format .ps1xml files. You can use the Update-FormatData cmdlet to add those files to the format data that it loads in the  shell. You do not need to restart the shell to update the format data.

 

PARAMETERS

 

-appendPath <string[]>

Specifies the path to optional format.ps1xml files which will be included in the list of files loaded. These are processed after the built-in files are loaded.

 

Required?

false

Position?

1

Default value

 

Accept pipeline input?  

true (ByValue, ByPropertyName)

Accept wildcard characters? 

true

 

-prependPath <string[]>

Specifies the path to optional format.ps1xml files which will be included in the list of files loaded. These files are processed in the order they are specified and before the built-in files are loaded.

 

Required?

false

Position?

named

Default value

 

Accept pipeline input?  

false

Accept wildcard characters? 

true

 

<CommonParameters>

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

 

INPUT TYPE

Object

 

NOTES

 

For more information, type "Get-Help Update-FormatData -detailed". For technical information, type "Get-Help Update-FormatData  -full".

 

When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".

 

EXAMPLE 1

 

update-formatdata

 

This command updates the shell format configuration files from the built-in format.ps1xml files.

 

EXAMPLE 2

 

update-typedata -prependpath RedFormat.format.Ps1xml,GreyFormat.format.Ps1xml

 

This command updates the shell format configuration from the built-in format files and adds format configuration information from two additional files. The Prependpath parameter causes the shell to process the new files before the built-in files.

 

RELATED LINKS

Update-TypeData