Export-FormatData
Speichert Formatierungsdaten aus der aktuellen Sitzung in einer Formatierungsdatei.
Syntax
ByPath (Standard)
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-Path <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
ByLiteralPath
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-LiteralPath <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
Beschreibung
Das Cmdlet Export-FormatData erstellt Windows PowerShell-Formatierungsdateien (format.ps1xml) aus den Formatierungsobjekten in der aktuellen Sitzung. Er verwendet die ExtendedTypeDefinition-Objekte , die Get-FormatData zurückgibt, und speichert sie in einer Datei im XML-Format.
Windows PowerShell verwendet die Daten in Formatierungsdateien (format.ps1xml), um die Standardanzeige von Microsoft .NET Framework-Objekten in der Sitzung zu generieren. Sie können die Formatierungsdateien anzeigen und bearbeiten und das Cmdlet Update-FormatData verwenden, um einer Sitzung die Formatierungsdaten hinzuzufügen.
Weitere Informationen zum Formatieren von Dateien in Windows PowerShell finden Sie unter about_Format.ps1xml.
Beispiele
Beispiel 1: Exportieren von Sitzungsformatdaten
PS C:\> Get-FormatData -TypeName "*" | Export-FormatData -Path "allformat.ps1xml" -IncludeScriptBlock
Mit diesem Befehl werden alle Formatdaten in der Sitzung in die Datei AllFormat.ps1xml exportiert.
Der Befehl verwendet das Cmdlet Get-FormatData, um die Formatdaten in der Sitzung abzurufen. Der Wert * (all) für den TypeName-Parameter weist das Cmdlet an, alle Daten in der Sitzung abzurufen.
Der Befehl verwendet einen Pipelineoperator (|), um die Formatdaten aus dem Befehl Get-FormatData an das Cmdlet Export-FormatData zu senden, das die Formatdaten in die AllFormat.ps1 Datei exportiert.
Der Befehl Export-FormatData verwendet den Parameter IncludeScriptBlock , um Skriptblöcke im Format Daten in die Datei einzuschließen.
Beispiel 2: Exportieren von Formatdaten für einen Typ
PS C:\> $F = Get-FormatData -TypeName "helpinfoshort"
PS C:\> Export-FormatData -InputObject $F -Path "c:\test\help.format.ps1xml" -IncludeScriptBlock
Diese Befehle exportieren die Formatdaten für den HelpInfoShort-Typ in die Datei "Help.format.ps1xml".
Der erste Befehl verwendet das Cmdlet Get-FormatData , um die Formatdaten für den HelpInfoShort-Typ abzurufen, und speichert sie in der Variablen $F.
Im zweiten Befehl wird der Parameter InputObject des Cmdlets Export-FormatData verwendet, um das Format der Daten einzugeben, die in der Variablen $F gespeichert sind. Außerdem wird der IncludeScriptBlock Parameter verwendet, um Skriptblöcke in die Ausgabe einzuschließen.
Beispiel 3: Exportieren von Formatdaten ohne Skriptblock
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
In diesem Beispiel wird gezeigt, wie sich das Weglassen des IncludeScriptBlock-Parameters in einem Export-FormatData-Befehl auswirkt.
Im ersten Befehl wird das Cmdlet Get-FormatData verwendet, um die Formatdaten für das System.Diagnostics.Process-Objekt abzurufen, das vom Cmdlet Get-Process zurückgegeben wird. Der Befehl verwendet einen Pipelineoperator (|), um die Formatierungsdaten an das Cmdlet Export-FormatData zu senden, das sie in die Datei Process.format.ps1xml im aktuellen Verzeichnis exportiert.
In diesem Fall verwendet der Befehl Export-FormatData nicht den Parameter IncludeScriptBlock .
Der zweite Befehl verwendet das Cmdlet Update-FormatData, um der aktuellen Sitzung die Datei Process.format.ps1xml hinzuzufügen. Der Befehl verwendet den Parameter PrependPath, um sicherzustellen, dass die Formatierungsdaten für Prozessobjekte in der Datei Process.format.ps1xml gefunden werden, bevor die Standardformatierungsdaten für Prozessobjekte gefunden werden.
Der dritte Befehl zeigt die Auswirkungen dieser Änderung. Der Befehl verwendet das Cmdlet Get-Process , um Prozesse abzurufen, deren Namen mit P beginnen. Die Ausgabe zeigt, dass Eigenschaftswerte, die mithilfe von Skriptblöcken berechnet werden, in der Anzeige fehlen.
Parameter
-Force
Erzwingt die Ausführung des Befehls, ohne eine Benutzerbestätigung zu verlangen.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-IncludeScriptBlock
Gibt an, ob Skriptblöcke in den Formatdaten exportiert werden.
Da Skriptblöcke Code enthalten und böswillig verwendet werden können, werden sie nicht standardmäßig exportiert.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-InputObject
Gibt die zu exportierenden Formatdatenobjekte an. Geben Sie eine Variable ein, die die Objekte enthält, oder einen Befehl, der die Objekte abruft, z. B. einen Get-FormatData-Befehl . Sie können die Objekte auch über die Pipeline von Get-FormatData an Export-FormatData übergeben.
Parametereigenschaften
| Typ: | ExtendedTypeDefinition[] |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | True |
| Wert aus Pipeline: | True |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-LiteralPath
Gibt einen Speicherort für die Ausgabedatei an. Im Gegensatz zum Path-Parameter wird der Wert LiteralPath- genau so verwendet, wie er eingegeben wird. Es werden keine Zeichen als Wildcards interpretiert. Wenn der Pfad Escapezeichen enthält, müssen Sie ihn in einfache Anführungszeichen einschließen. Einfache Anführungszeichen weisen Windows PowerShell an, keine Zeichen als Escapesequenzen zu interpretieren.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
| Aliase: | PSPath |
Parametersätze
ByLiteralPath
| Position: | Named |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-NoClobber
Inidicatest, dass das Cmdlet vorhandene Dateien nicht überschreibt. Standardmäßig überschreibt Export-FormatData Dateien ohne Warnung, es sei denn, die Datei verfügt über das schreibgeschützte Attribut.
Um Export-FormatData so zu veranlassen, schreibgeschützte Dateien zu überschreiben, verwenden Sie den Force-Parameter .
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
| Aliase: | NoOverwrite |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Path
Gibt einen Speicherort für die Ausgabedatei an. Geben Sie einen Pfad (optional) und einen Dateinamen mit der Dateinamenerweiterung format.ps1xml ein. Wenn Sie den Pfad weglassen, erstellt Export-FormatData die Datei im aktuellen Verzeichnis.
Wenn Sie eine andere Dateinamenerweiterung als .ps1xml verwenden, wird die Datei vom Cmdlet Update-FormatData nicht erkannt.
Wenn Sie eine vorhandene Datei angeben, wird die Datei von Export-FormatData ohne Warnung überschrieben, es sei denn, die Datei verfügt über das schreibgeschützte Attribut. Verwenden Sie zum Überschreiben einer schreibgeschützten Datei den Parameter Force. Um zu verhindern, dass Dateien überschrieben werden, verwenden Sie den NoClobber Parameter.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
| Aliase: | FilePath |
Parametersätze
ByPath
| Position: | Named |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.
Eingaben
ExtendedTypeDefinition
Sie können ExtendedTypeDefinition-Objekte über die Pipeline von Get-FormatData an Export-FormatData übergeben.
Ausgaben
None
Export-FormatData gibt keine Objekte zurück. Sie generiert eine Datei und speichert sie im angegebenen Pfad.
Hinweise
Um eine beliebige Formatierungsdatei zu verwenden, einschließlich einer exportierten Formatierungsdatei, muss die Ausführungsrichtlinie für die Sitzung skripts und Konfigurationsdateien ausführen lassen. Weitere Informationen finden Sie unter about_Execution_Policies.