Export-FormatData
Menyimpan data pemformatan dari sesi saat ini dalam file pemformatan.
Sintaks
ByPath (Default)
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-Path <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
ByLiteralPath
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-LiteralPath <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
Deskripsi
cmdlet Export-FormatData membuat file pemformatan PowerShell (format.ps1xml) dari objek pemformatan dalam sesi saat ini. Dibutuhkan objek ExtendedTypeDefinition yang Get-FormatData mengembalikan dan menyimpannya dalam file dalam format XML.
PowerShell menggunakan data dalam memformat file (format.ps1xml) untuk menghasilkan tampilan default objek Microsoft .NET Framework dalam sesi. Anda dapat melihat dan mengedit file pemformatan dan menggunakan cmdlet Update-FormatData untuk menambahkan data pemformatan ke sesi.
Untuk informasi selengkapnya tentang memformat file di PowerShell, lihat about_Format.ps1xml.
Contoh
Contoh 1: Mengekspor data format sesi
Get-FormatData -TypeName "*" |
Export-FormatData -Path "AllFormat.ps1xml" -IncludeScriptBlock
Perintah ini mengekspor semua data format dalam sesi ke file AllFormat.ps1xml.
Perintah menggunakan cmdlet Get-FormatData untuk mendapatkan data format dalam sesi. Nilai * (semua) untuk parameter TypeName mengarahkan cmdlet untuk mendapatkan semua data dalam sesi.
Perintah menggunakan operator alur (|) untuk mengirim data format dari perintah Get-FormatData ke cmdlet Export-FormatData, yang mengekspor data format ke file AllFormat.ps1xml.
Perintah Export-FormatData menggunakan parameter IncludeScriptBlock untuk menyertakan blok skrip dalam data format dalam file.
Contoh 2: Mengekspor data format untuk jenis
$F = Get-FormatData -TypeName "HelpInfoShort"
Export-FormatData -InputObject $F -Path "C:\test\Help.format.ps1xml" -IncludeScriptBlock
Perintah ini mengekspor data format untuk jenis HelpInfoShort ke file Help.format.ps1xml.
Perintah pertama menggunakan cmdlet Get-FormatData untuk mendapatkan data format untuk jenis HelpInfoShort, dan menyimpannya dalam variabel $F.
Perintah kedua menggunakan parameter InputObject cmdlet Export-FormatData untuk memasukkan data format yang disimpan dalam variabel $F. Ini juga menggunakan parameter
Contoh 3: Mengekspor data format tanpa blok skrip
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
Contoh ini menunjukkan efek menghilangkan parameter IncludeScriptBlock dari perintah Export-FormatData.
Perintah pertama menggunakan cmdlet Get-FormatData untuk mendapatkan data format untuk objek System.Diagnostics.Process yang dikembalikan cmdlet Get-Process. Perintah menggunakan operator alur (|) untuk mengirim data pemformatan ke cmdlet Export-FormatData, yang mengekspornya ke file Process.format.ps1xml di direktori saat ini.
Dalam hal ini, perintah Export-FormatData tidak menggunakan parameter IncludeScriptBlock.
Perintah kedua menggunakan cmdlet Update-FormatData untuk menambahkan file Process.format.ps1xml ke sesi saat ini. Perintah menggunakan parameter PrependPath untuk memastikan bahwa data pemformatan untuk objek proses dalam file Process.format.ps1xml ditemukan sebelum data pemformatan standar untuk objek proses.
Perintah ketiga menunjukkan efek perubahan ini. Perintah menggunakan cmdlet Get-Process untuk mendapatkan proses yang memiliki nama yang dimulai dengan P. Output menunjukkan bahwa nilai properti yang dihitung dengan menggunakan blok skrip hilang dari tampilan.
Parameter
-Force
Memaksa perintah untuk dijalankan tanpa meminta konfirmasi pengguna.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-IncludeScriptBlock
Menunjukkan apakah blok skrip dalam data format diekspor.
Karena blok skrip berisi kode dan dapat digunakan dengan berbahaya, blok skrip tidak diekspor secara default.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-InputObject
Menentukan objek data format yang akan diekspor. Masukkan variabel yang berisi objek atau perintah yang mendapatkan objek, seperti perintah Get-FormatData. Anda juga dapat menyalurkan objek dari Get-FormatData ke Export-FormatData.
Properti parameter
| Jenis: | |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | True |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-LiteralPath
Menentukan lokasi untuk file output. Tidak seperti parameter Jalur
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | PSPath, LP |
Set parameter
ByLiteralPath
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-NoClobber
Menunjukkan bahwa cmdlet tidak menimpa file yang ada. Secara default, Export-FormatData menimpa file tanpa peringatan kecuali file memiliki atribut baca-saja.
Untuk mengarahkan Export-FormatData menimpa file baca-saja, gunakan parameter Force.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | NoOverwrite |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Path
Menentukan lokasi untuk file output. Masukkan jalur (opsional) dan nama file dengan ekstensi nama file format.ps1xml. Jika Anda menghilangkan jalur, Export-FormatData membuat file di direktori saat ini.
Jika Anda menggunakan ekstensi nama file selain .ps1xml, cmdlet Update-FormatData tidak akan mengenali file.
Jika Anda menentukan file yang ada, Export-FormatData menimpa file tanpa peringatan, kecuali file memiliki atribut baca-saja. Untuk menimpa file baca-saja, gunakan parameter Force. Untuk mencegah file ditimpa, gunakan parameter NoClobber
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | FilePath |
Set parameter
ByPath
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CommonParameters
Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.
Input
ExtendedTypeDefinition
Anda dapat menyalurkan objek ExtendedTypeDefinition dari Get-FormatData ke cmdlet ini.
Output
None
Cmdlet ini tidak mengembalikan output. Ini menghasilkan file dan menyimpannya di jalur yang ditentukan.
Catatan
- Untuk menggunakan file pemformatan apa pun, termasuk file pemformatan yang diekspor, kebijakan eksekusi untuk sesi harus mengizinkan skrip dan file konfigurasi untuk dijalankan. Untuk informasi lebih lanjut, lihat about_Execution_Policies.