Export-FormatData
Zapisuje formatowanie danych z bieżącej sesji w pliku formatowania.
Składnia
ByPath (Domyślna)
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-Path <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
ByLiteralPath
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-LiteralPath <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
Opis
Polecenie cmdlet Export-FormatData tworzy pliki formatowania programu PowerShell (format.ps1xml) z obiektów formatowania w bieżącej sesji. Pobiera ExtendedTypeDefinition obiektów, które Get-FormatData zwraca i zapisuje je w pliku w formacie XML.
Program PowerShell używa danych w plikach formatowania (format.ps1xml) do generowania domyślnego wyświetlania obiektów programu Microsoft .NET Framework w sesji. Możesz wyświetlić i edytować pliki formatowania oraz użyć polecenia cmdlet Update-FormatData, aby dodać dane formatowania do sesji.
Aby uzyskać więcej informacji na temat formatowania plików w programie PowerShell, zobacz about_Format.ps1xml.
Przykłady
Przykład 1. Eksportowanie danych formatu sesji
Get-FormatData -TypeName "*" | Export-FormatData -Path "AllFormat.ps1xml" -IncludeScriptBlock
To polecenie eksportuje wszystkie dane formatu w sesji do pliku AllFormat.ps1xml.
Polecenie używa cmdletu Get-FormatData do pobrania danych formatu w sesji. Wartość * (wszystkie) parametru TypeName kieruje cmdlet, aby pobrać wszystkie dane z sesji.
Polecenie używa operatora potoku (|) do wysyłania danych formatu z polecenia Get-FormatData do polecenia cmdlet Export-FormatData, które eksportuje dane formatu do pliku AllFormat.ps1xml.
Polecenie Export-FormatData używa parametru IncludeScriptBlock w celu uwzględnienia bloków skryptu w danych formatu w pliku.
Przykład 2. Eksportowanie danych formatu dla typu
$F = Get-FormatData -TypeName "helpinfoshort"
Export-FormatData -InputObject $F -Path "C:\test\Help.format.ps1xml" -IncludeScriptBlock
Te polecenia eksportują dane formatu HelpInfoShort typ do pliku Help.format.ps1xml.
Pierwsze polecenie używa polecenia cmdlet Get-FormatData, aby pobrać dane formatu HelpInfoShort typu i zapisuje je w zmiennej $F.
Drugie polecenie używa parametru InputObject polecenia cmdlet Export-FormatData, aby wprowadzić dane formatu zapisane w zmiennej $F. Używa również parametru IncludeScriptBlock w celu uwzględnienia bloków skryptu w danych wyjściowych.
Przykład 3. Eksportowanie danych formatu bez bloku skryptu
Get-FormatData -TypeName "System.Diagnostics.Process" | Export-FormatData -Path Process.format.ps1xml
Update-FormatData -PrependPath ".\Process.format.ps1xml"
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
W tym przykładzie pokazano efekt pominięcia parametru IncludeScriptBlock z polecenia Export-FormatData.
Pierwsze polecenie używa polecenia cmdlet Get-FormatData w celu pobrania danych formatu dla obiektu System.Diagnostics.Process zwracanego przez polecenie cmdlet Get-Process. Polecenie używa operatora potoku (|) do wysyłania danych formatowania do polecenia cmdlet Export-FormatData, które eksportuje go do pliku Process.format.ps1xml w bieżącym katalogu.
W tym przypadku polecenie Export-FormatData nie używa parametru IncludeScriptBlock.
Drugie polecenie używa polecenia cmdlet Update-FormatData, aby dodać plik Process.format.ps1xml do bieżącej sesji. Polecenie używa parametru PrependPath, aby upewnić się, że formatowanie danych dla obiektów przetwarzania w pliku Process.format.ps1xml zostanie znalezione przed standardowym formatowaniem danych dla obiektów przetwarzania.
Trzecie polecenie pokazuje skutki tej zmiany. Polecenie używa polecenia cmdlet Get-Process do pobierania procesów, które mają nazwy rozpoczynające się od P. Dane wyjściowe pokazują, że w ekranie brakuje wartości właściwości obliczanych przy użyciu bloków skryptów.
Parametry
-Force
Wymusza uruchomienie polecenia bez monitowania o potwierdzenie użytkownika.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-IncludeScriptBlock
Wskazuje, czy bloki skryptu w formacie danych są eksportowane.
Ponieważ bloki skryptów zawierają kod i mogą być używane złośliwie, nie są one domyślnie eksportowane.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-InputObject
Określa format obiektów danych do wyeksportowania. Wprowadź zmienną zawierającą obiekty lub polecenie, które pobiera obiekty, takie jak polecenie Get-FormatData. Można również przekazywać obiekty z Get-FormatData do Export-FormatData.
Właściwości parametru
| Typ: | |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | True |
| Wartość z potoku: | True |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-LiteralPath
Określa lokalizację pliku wyjściowego. W przeciwieństwie do parametru Path wartość LiteralPath jest używana dokładnie tak, jak jest typowana. Żadne znaki nie są interpretowane jako symbole wieloznaczne. Jeśli ścieżka zawiera znaki ucieczki, należy ująć ją w pojedynczy cudzysłów. Pojedyncze cudzysłowy wskazują programowi PowerShell, aby nie interpretował żadnych znaków jako sekwencji ucieczki.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
| Aliasy: | PSPath, LP |
Zestawy parametrów
ByLiteralPath
| Position: | Named |
| Obowiązkowy: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-NoClobber
Wskazuje, że polecenie cmdlet nie zastępuje istniejących plików. Domyślnie Export-FormatData zastępuje pliki bez ostrzeżenia, chyba że plik ma atrybut tylko do odczytu.
Aby skierować Export-FormatData do zastępowania plików tylko do odczytu, użyj parametru Force.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
| Aliasy: | NoOverwrite |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Path
Określa lokalizację pliku wyjściowego.
Wprowadź ścieżkę (opcjonalnie) i nazwę pliku z rozszerzeniem nazwy pliku format.ps1xml.
Jeśli pominięto ścieżkę, Export-FormatData utworzy plik w bieżącym katalogu.
Jeśli używasz rozszerzenia nazwy pliku innego niż .ps1xml, polecenie cmdlet Update-FormatData nie rozpozna pliku.
Jeśli określisz istniejący plik, Export-FormatData zastąpi plik bez ostrzeżenia, chyba że plik ma atrybut tylko do odczytu. Aby nadpisać plik o ustawieniach tylko do odczytu, użyj parametru Force. Aby zapobiec zastępowaniu plików, użyj parametru NoClobber.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
| Aliasy: | FilePath |
Zestawy parametrów
ByPath
| Position: | Named |
| Obowiązkowy: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
CommonParameters
To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.
Dane wejściowe
ExtendedTypeDefinition
Możesz przekierować za pomocą potoku obiekty ExtendedTypeDefinition z Get-FormatData do tego polecenia cmdlet.
Dane wyjściowe
None
To polecenie cmdlet nie zwraca żadnych danych wyjściowych. Generuje plik i zapisuje go w określonej ścieżce.
Uwagi
- Aby użyć dowolnego pliku formatowania, w tym wyeksportowanego pliku formatowania, zasady wykonywania sesji muszą zezwalać na uruchamianie skryptów i plików konfiguracji. Aby uzyskać więcej informacji, przejdź do about_Execution_Policies.