Partilhar via

Update-FormatData

Módulo:
Microsoft.PowerShell.Utility Module

Atualiza os dados de formatação na sessão atual.

Sintaxe

Default (Predefinição) 

Update-FormatData
    [[-AppendPath] <String[]>]
    [-PrependPath <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

O cmdlet Update-FormatData recarrega os dados de formatação dos ficheiros de formatação para a sessão atual. Este cmdlet permite atualizar os dados de formatação sem reiniciar o PowerShell.

Sem parâmetros, Update-FormatData recarrega os arquivos de formatação que carregou anteriormente. Você pode usar os parâmetros do Update-FormatData para adicionar novos arquivos de formatação à sessão.

Arquivos de formatação são arquivos de texto em formato XML com a extensão de nome de arquivo format.ps1xml. Os dados de formatação nos arquivos definem a exibição de objetos do Microsoft .NET Framework na sessão.

Quando o PowerShell é iniciado, ele carrega os dados de formato do código-fonte do PowerShell. No entanto, você pode criar arquivos format.ps1xml personalizados para atualizar a formatação na sessão atual. Você pode usar o Update-FormatData para recarregar os dados de formatação na sessão atual sem reiniciar o PowerShell. Isso é útil quando você adicionou ou alterou um arquivo de formatação, mas não deseja interromper a sessão.

Para obter mais informações sobre como formatar arquivos no PowerShell, consulte about_Format.ps1xml.

Exemplos

Exemplo 1: Recarregar ficheiros de formatação carregados anteriormente

Update-FormatData

Este comando recarrega os ficheiros de formatação que carregou anteriormente.

Exemplo 2: Recarregar ficheiros de formatação e rastrear e registar ficheiros de formatação

Update-FormatData -AppendPath Trace.format.ps1xml, Log.format.ps1xml

Este comando recarrega os ficheiros de formatação na sessão, incluindo dois novos ficheiros, Trace.format.ps1xml e Log.format.ps1xml.

Como o comando usa o parâmetro AppendPath, os dados de formatação nos novos arquivos são carregados após os dados de formatação dos arquivos internos.

O parâmetro AppendPath é usado porque os novos arquivos contêm dados de formatação para objetos que não são referenciados nos arquivos internos.

Exemplo 3: Editar um arquivo de formatação e recarregá-lo

Update-FormatData -PrependPath "C:\test\NewFiles.format.ps1xml"

# Edit the NewFiles.format.ps1 file.

Update-FormatData

Este exemplo mostra como recarregar um arquivo de formatação depois de editá-lo.

O primeiro comando adiciona o arquivo NewFiles.format.ps1xml à sessão. Ele usa o parâmetro PrependPath porque o arquivo contém dados de formatação para objetos que são referenciados nos arquivos internos.

Depois de adicionar o arquivo NewFiles.format.ps1xml e testá-lo nessas sessões, o autor edita o arquivo.

O segundo comando usa o cmdlet Update-FormatData para recarregar os arquivos de formatação. Como o arquivo NewFiles.format.ps1xml foi carregado anteriormente, o Update-FormatData o recarrega automaticamente sem usar parâmetros.

Parâmetros

-AppendPath

Especifica os arquivos de formatação que esse cmdlet adiciona à sessão. Os arquivos são carregados depois que o PowerShell carrega os arquivos de formatação internos.

Ao formatar objetos .NET, o PowerShell usa a primeira definição de formatação que encontra para cada tipo .NET. Se você usar o parâmetro AppendPath, o PowerShell pesquisará os dados dos arquivos internos antes de encontrar os dados de formatação que você está adicionando.

Use esse parâmetro para adicionar um arquivo que formata um objeto .NET que não é referenciado nos arquivos de formatação internos.

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:PSPath, Caminho

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:False
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-PrependPath

Especifica os arquivos de formatação que esse cmdlet adiciona à sessão. Os arquivos são carregados antes que o PowerShell carregue os arquivos de formatação internos.

Ao formatar objetos .NET, o PowerShell usa a primeira definição de formatação que encontra para cada tipo .NET. Se você usar o parâmetro PrependPath, o PowerShell pesquisará os dados dos arquivos que você está adicionando antes de encontrar os dados de formatação dos arquivos internos.

Use esse parâmetro para adicionar um arquivo que formata um objeto .NET que também é referenciado nos arquivos de formatação internos.

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

String

Você pode canalizar uma cadeia de caracteres que contenha o caminho de anexação para este cmdlet.

Saídas

None

Este cmdlet não retorna nenhuma saída.

Notas

  • Update-FormatData também atualiza os dados de formatação para comandos na sessão que foram importados dos módulos. Se o arquivo de formatação de um módulo for alterado, você poderá executar um comando Update-FormatData para atualizar os dados de formatação dos comandos importados. Não é necessário importar o módulo novamente.