Salva dados de formatação da sessão atual em um arquivo de formatação.
Sintaxe
Export-FormatData [-Force] [-IncludeScriptBlock] [-InputObject <ExtendedTypeDefinition[]>] [-NoClobber] [-Path <string>] [<CommonParameters>]
Descrição
O cmdlet Export-FormatData cria arquivos de formatação do Windows PowerShell (format.ps1xml) a partir dos objetos de formatação na sessão atual. Ele salva os objetos ExtendedTypeDefinition que o Get-FormatData retorna em um arquivo XML.
O Windows PowerShell usa os dados dos arquivos de formatação (format.ps1xml) para gerar a exibição padrão de objetos do Microsoft .NET Framework na sessão. Você pode exibir e editar os arquivos de formatação e usar o cmdlet Update-FormatData para acrescentar os dados de formatação a uma sessão.
Para obter mais informações sobre arquivos de formatação no Windows PowerShell, consulte about_Format.ps1xml.
Parâmetros
-Force
Substitui um arquivo de saída existente, mesmo que o arquivo tenha o atributo somente leitura.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
False |
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-IncludeScriptBlock
Determina se são exportados blocos de script nos dados de formato.
Como os blocos de script contêm código e podem ser usados de forma maliciosa, eles não são exportados por padrão.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
False |
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-InputObject <ExtendedTypeDefinition[]>
Especifica os objetos de dados de formato a serem exportados. Insira uma variável que contenha os objetos ou digite um comando que obtenha os objetos, como o comando Get-FormatData. Você também pode canalizar os objetos do Get-FormatData para o Export-FormatData.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
true (ByValue) |
|
Aceitar caracteres curinga? |
false |
-NoClobber
Impede o cmdlet de substituir arquivos existentes. Por padrão, Export-FormatData substitui arquivos sem aviso prévio, a menos que o arquivo tenha o atributo somente leitura.
Para direcionar Export-FormatData para substituir arquivos somente leitura, use o parâmetro Force.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Path <string>
Especifica um local para o arquivo de saída. Insira um caminho (opcional) e um nome de arquivo com uma extensão format.ps1xml. Se você omitir o caminho, Export-FormatData criará o arquivo no diretório atual.
Se você usar uma extensão de nome de arquivo diferente de .ps1xml, o cmdlet Update-FormatData não reconhecerá o arquivo.
Se você especificar um arquivo existente, Export-FormatData substituirá o arquivo sem aviso prévio, a menos que o arquivo tenha o atributo somente leitura. Para substituir um arquivo somente leitura, use o parâmetro Force. Para impedir que os arquivos sejam substituídos, use o parâmetro NoClobber.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
nenhum |
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
|
Entradas |
System.Management.Automation.ExtendedTypeDefinition Você pode canalizar objetos ExtendedTypeDefinition do Get-FormatData para o Export-FormatData. |
|
Saídas |
None Export-FormatData não retorna objetos. Ele gera um arquivo e o salva no caminho especificado. |
Observações
Para usar qualquer arquivo de formatação, inclusive um arquivo de formatação exportado, a diretiva de execução durante a sessão deve permitir que scripts e arquivos de configuração sejam executados. Para obter mais informações, consulte about_Execution_Policies.
Exemplo 1
C:\PS>get-formatdata -typename * | export-formatdata -path allformat.ps1xml -IncludeScriptBlock Descrição ----------- Esse comando exporta todos os dados de formato na sessão para o arquivo AllFormat.ps1xml. O comando usa o cmdlet Get-FormatData para obter os dados de formato na sessão. Um valor igual a * (all) para o parâmetro TypeName direciona o cmdlet para obter todos os dados na sessão. O comando usa um operador de pipeline (|) para enviar os dados de formato do comando Get-FormatData para o cmdlet Export-FormatData, que exporta os dados de formato para o arquivo AllFormat.ps1. O comando Export-FormatData usa o parâmetro IncludeScriptBlock para incluir blocos de script dos dados de formato no arquivo.
Exemplo 2
C:\PS>$f = get-formatdata -typename helpinfoshort C:\PS> export-formatdata -inputObject $f -path c:\test\help.format.ps1xml -IncludeScriptBlock Descrição ----------- Esses comandos exportam os dados de formato do tipo HelpInfoShort para o arquivo Help.format.ps1xml. O primeiro comando usa o cmdlet Get-FormatData para obter os dados de formato do tipo HelpInfoShort e os salva na variável $f. O segundo comando usa o parâmetro InputObject do Export-FormatData para inserir os dados de formato salvos na variável $f. Ele também usa o parâmetro IncludeScriptBlock para incluir blocos de script na saída.
Exemplo 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
Descrição
-----------
Esse exemplo mostra o efeito da omissão do parâmetro IncludeScriptBlock de um comando Export-FormatData.
O primeiro comando usa o cmdlet Get-FormatData para obter os dados de formato para o objeto System.Diagnostics.Process que o cmdlet Get-Process retorna. O comando usa um operador de pipeline (|) para enviar os dados de formatação ao cmdlet Export-FormatData, que os exporta para o arquivo Process.format.ps1xml no diretório atual.
Nesse caso, o comando Export-FormatData não usa o parâmetro IncludeScriptBlock.
O segundo comando usa o cmdlet Update-FormatData para acrescentar o arquivo Process.format.ps1xml à sessão atual. O comando usa o parâmetro PrependPath para garantir que os dados de formatação para objetos de processos no arquivo Process.format.ps1xml sejam localizados antes dos dados de formatação padrão para objetos de processos.
O terceiro comando mostra os efeitos dessa alteração.
O comando usa o cmdlet Get-Process para obter os processos cujos nomes começam com "P". A saída mostra que os valores de propriedade calculados usando blocos de script não aparecem na exibição.
See Also