Sdílet prostřednictvím

Export-FormatData

  • Reference
Modul:
Microsoft.PowerShell.Utility

Uloží formátování dat z aktuální relace do souboru formátování.

Syntaxe

Export-FormatData
      -InputObject <ExtendedTypeDefinition[]>
      -Path <String>
      [-Force]
      [-NoClobber]
      [-IncludeScriptBlock]
      [<CommonParameters>]
Export-FormatData
      -InputObject <ExtendedTypeDefinition[]>
      -LiteralPath <String>
      [-Force]
      [-NoClobber]
      [-IncludeScriptBlock]
      [<CommonParameters>]

Description

Rutina Export-FormatData vytvoří soubory formátování prostředí Windows PowerShell (format.ps1xml) z objektů formátování v aktuální relaci. Vezme ExtendedTypeDefinition objekty, které Get-FormatData vrátí a uloží je do souboru ve formátu XML.

Windows PowerShell používá data ve formátovacích souborech (format.ps1xml) k vygenerování výchozího zobrazení objektů rozhraní Microsoft .NET Framework v relaci. Můžete zobrazit a upravit soubory formátování a pomocí rutiny Update-FormatData přidat data formátování do relace.

Další informace o formátování souborů ve Windows PowerShellu najdete v tématu about_Format.ps1xml.

Příklady

Příklad 1: Export dat formátu relace

PS C:\> Get-FormatData -TypeName "*" | Export-FormatData -Path "allformat.ps1xml" -IncludeScriptBlock

Tento příkaz exportuje všechna formátová data v relaci do souboru AllFormat.ps1xml.

Příkaz používá rutinu Get-FormatData k získání dat formátu v relaci. Hodnota * (vše) pro parametr TypeName nasměruje rutinu tak, aby získala všechna data v relaci.

Příkaz pomocí operátoru kanálu (|) odešle data formátu z příkazu Get-FormatData do rutiny Export-FormatData, která exportuje data formátu do souboru AllFormat.ps1.

Příkaz Export-FormatData používá parametr IncludeScriptBlock k zahrnutí bloků skriptu do formátových dat v souboru.

Příklad 2: Export dat formátu pro typ

PS C:\> $F = Get-FormatData -TypeName "helpinfoshort"
PS C:\> Export-FormatData -InputObject $F -Path "c:\test\help.format.ps1xml" -IncludeScriptBlock

Tyto příkazy exportují data formátu pro typ HelpInfoShort do souboru Help.format.ps1xml.

První příkaz používá rutinu Get-FormatData k získání formátových dat pro typ HelpInfoShort a uloží je do proměnné $F.

Druhý příkaz používá parametr InputObject rutiny Export-FormatData k zadání dat formátu uložených v proměnné $F. Používá také parametr IncludeScriptBlock k zahrnutí bloků skriptu do výstupu.

Příklad 3: Export dat formátu bez bloku skriptu

PS C:\> Get-FormatData -TypeName "System.Diagnostics.Process" | Export-FormatData -Path process.format.ps1xml
PS C:\> Update-FormatData -PrependPath ".\process.format.ps1xml"
PS C:\> 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

Tento příklad ukazuje účinek vynechání parametru IncludeScriptBlock z příkazu Export-FormatData.

První příkaz pomocí rutiny Get-FormatData získá formátová data pro System.Diagnostics.Process objekt, který Get-Process rutina vrátí. Příkaz pomocí operátoru kanálu (|) odešle formátovací data do rutiny Export-FormatData, která je exportuje do souboru Process.format.ps1xml v aktuálním adresáři.

V tomto případě příkaz Export-FormatData nepoužívá parametr IncludeScriptBlock.

Druhý příkaz použije rutinu Update-FormatData k přidání souboru Process.format.ps1xml do aktuální relace. Příkaz používá parametr PrependPath k zajištění, že se před standardním formátováním dat pro procesní objekty v souboru Process.format.ps1xml najde standardní formátovací data pro procesní objekty.

Třetí příkaz ukazuje účinky této změny. Příkaz používá rutinu Get-Process k získání procesů, které mají názvy začínající písmenem P. Výstup ukazuje, že v zobrazení chybí hodnoty vlastností vypočítané pomocí bloků skriptu.

Parametry

-Force

Vynutí spuštění příkazu bez výzvy k potvrzení uživatele.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-IncludeScriptBlock

Určuje, zda jsou bloky skriptu ve formátových datech exportovány.

Vzhledem k tomu, že bloky skriptu obsahují kód a dají se použít se zlými úmysly, ve výchozím nastavení se neexportují.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-InputObject

Určuje formát datových objektů, které se mají exportovat. Zadejte proměnnou obsahující objekty nebo příkaz, který získá objekty, například příkaz Get-FormatData. Objekty můžete také převést z Get-FormatData do Export-FormatData.

Typ:ExtendedTypeDefinition[]
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-LiteralPath

Určuje umístění výstupního souboru. Na rozdíl od parametru Path se hodnota LiteralPath používá přesně tak, jak je zadána. Žádné znaky nejsou interpretovány jako zástupné znaky. Pokud cesta obsahuje řídicí znaky, uzavřete ji do jednoduchých uvozovek. Jednoduché uvozovky říkají prostředí Windows PowerShell, aby nepřekládaly žádné znaky jako řídicí sekvence.

Typ:String
Aliasy:PSPath
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-NoClobber

Inidicatest, že rutina nepřepíše existující soubory. Ve výchozím nastavení Export-FormatData přepíše soubory bez upozornění, pokud soubor nemá atribut jen pro čtení.

Pokud chcete směrovat Export-FormatData k přepsání souborů jen pro čtení, použijte parametr Force.

Typ:SwitchParameter
Aliasy:NoOverwrite
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Path

Určuje umístění výstupního souboru. Zadejte cestu (volitelné) a název souboru s příponou názvu souboru format.ps1xml. Pokud cestu vynecháte, Export-FormatData vytvoří soubor v aktuálním adresáři.

Pokud používáte jinou příponu názvu souboru než .ps1xml, rutina Update-FormatData soubor nerozpozná.

Pokud zadáte existující soubor, Export-FormatData přepíše soubor bez upozornění, pokud soubor nemá atribut jen pro čtení. K přepsání souboru jen pro čtení použijte parametr Force. Pokud chcete zabránit přepsání souborů, použijte parametr NoClobber.

Typ:String
Aliasy:FilePath
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

ExtendedTypeDefinition

Objekty ExtendedTypeDefinition můžete Get-FormatDataExport-FormatData.

Výstupy

None

Export-FormatData nevrací žádné objekty. Vygeneruje soubor a uloží ho do zadané cesty.

Poznámky

  • Pokud chcete použít jakýkoli formátovací soubor, včetně exportovaného formátovacího souboru, musí zásady spouštění relace umožňovat spouštění skriptů a konfiguračních souborů. Další informace najdete v tématu about_Execution_Policies.