Format-Custom
Menggunakan tampilan yang disesuaikan untuk memformat output.
Sintaks
Format-Custom
[[-Property] <Object[]>]
[-Depth <Int32>]
[-GroupBy <Object>]
[-View <String>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <String>]
[-InputObject <PSObject>]
[<CommonParameters>]
Deskripsi
Format-Custom
Cmdlet memformat output perintah seperti yang didefinisikan dalam tampilan alternatif.
Format-Custom
dirancang untuk menampilkan tampilan yang bukan hanya tabel atau hanya daftar. Anda bisa menggunakan tampilan yang ditentukan di PowerShell, atau Anda bisa membuat tampilan Anda sendiri dalam file baru format.ps1xml
dan menggunakan Update-FormatData
cmdlet untuk menambahkannya ke PowerShell.
Contoh
Contoh 1: Memformat output dengan tampilan kustom
Get-Command Start-Transcript | Format-Custom -View MyView
Perintah ini memformat informasi tentang Start-Transcript
cmdlet dalam format yang ditentukan oleh tampilan MyView, tampilan kustom yang dibuat oleh pengguna. Agar berhasil menjalankan perintah ini, Anda harus terlebih dahulu membuat file PS1XML baru, menentukan tampilan MyView , lalu menggunakan Update-FormatData
perintah untuk menambahkan file PS1XML ke PowerShell.
Contoh 2: Memformat output dengan tampilan default
Get-Process Winlogon | Format-Custom
Perintah ini memformat informasi tentang proses Winlogon dalam tampilan yang disesuaikan alternatif.
Karena perintah tidak menggunakan parameter Tampilan , Format-Custom
menggunakan tampilan kustom default untuk memformat data.
Contoh 3: Pemecahan masalah kesalahan format
Contoh berikut menunjukkan hasil penambahan parameter DisplayError atau ShowError dengan ekspresi.
PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -DisplayError
class DateTime
{
DayOfWeek = Friday
$_ / $null = #ERR
}
PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError
class DateTime
{
DayOfWeek = Friday
$_ / $null =
}
Failed to evaluate expression " $_ / $null ".
+ CategoryInfo : InvalidArgument: (12/21/2018 8:01:04 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError
Parameter
-Depth
Menentukan jumlah kolom dalam tampilan.
Jenis: | Int32 |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-DisplayError
Menampilkan kesalahan pada baris perintah. Parameter ini jarang digunakan, tetapi dapat digunakan sebagai bantuan penelusuran kesalahan saat Anda memformat ekspresi dalam Format-Custom
perintah, dan ekspresi tampaknya tidak berfungsi.
Jenis: | SwitchParameter |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-Expand
Memformat objek koleksi, serta objek dalam koleksi. Parameter ini dirancang untuk memformat objek yang mendukung antarmuka System.Collections.ICollection . Nilai defaultnya adalah EnumOnly.
Nilai yang valid adalah:
- EnumOnly: Menampilkan properti objek dalam koleksi.
- CoreOnly: Menampilkan properti objek koleksi.
- Keduanya: Menampilkan properti objek koleksi dan objek dalam koleksi.
Jenis: | String |
Nilai yang diterima: | CoreOnly, EnumOnly, Both |
Position: | Named |
Nilai default: | EnumOnly |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-Force
Mengarahkan cmdlet untuk menampilkan semua informasi kesalahan. Gunakan dengan parameter DisplayError atau ShowError . Secara default, ketika objek kesalahan ditulis ke kesalahan atau menampilkan aliran, hanya beberapa informasi kesalahan yang ditampilkan.
Jenis: | SwitchParameter |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-GroupBy
Memformat output dalam grup berdasarkan properti atau nilai bersama. Masukkan ekspresi atau properti output.
Nilai parameter GroupBy dapat menjadi properti terhitung baru. Properti terhitung dapat berupa blok skrip atau tabel hash. Pasangan kunci-nilai yang valid adalah:
- Nama (atau Label) -
<string>
- Ekspresi -
<string>
atau<script block>
- FormatString -
<string>
Untuk informasi selengkapnya, lihat about_Calculated_Properties.
Jenis: | Object |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-InputObject
Menentukan objek yang akan diformat. Masukkan variabel yang berisi objek atau ketik perintah atau ekspresi yang mendapatkan objek.
Jenis: | PSObject |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-Property
Menentukan properti objek yang muncul dalam tampilan dan urutan munculnya. Kartubebas diizinkan.
Jika Anda menghilangkan parameter ini, properti yang muncul di tampilan bergantung pada objek yang ditampilkan. Properti nama parameter bersifat opsional. Anda tidak dapat menggunakan parameter Properti dan Tampilan dalam perintah yang sama.
Nilai parameter Properti dapat menjadi properti terhitung baru. Properti terhitung dapat berupa blok skrip atau tabel hash. Pasangan kunci-nilai yang valid adalah:
- Ekspresi -
<string>
atau<script block>
- Dalam-
<int32>
Untuk informasi selengkapnya, lihat about_Calculated_Properties.
Jenis: | Object[] |
Position: | 0 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | True |
-ShowError
Mengirim kesalahan melalui alur. Parameter ini jarang digunakan, tetapi dapat digunakan sebagai bantuan penelusuran kesalahan saat Anda memformat ekspresi dalam Format-Custom
perintah, dan ekspresi tampaknya tidak berfungsi.
Jenis: | SwitchParameter |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-View
Menentukan nama format atau tampilan alternatif. Jika Anda menghilangkan parameter ini, Format-Custom
gunakan tampilan kustom default. Anda tidak dapat menggunakan parameter Properti dan Tampilan dalam perintah yang sama.
Jenis: | String |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
Input
Anda dapat menyalurkan objek apa pun ke cmdlet ini.
Output
Microsoft.PowerShell.Commands.Internal.Format
Cmdlet ini mengembalikan objek format yang mewakili tampilan.
Catatan
PowerShell menyertakan alias berikut untuk Format-Custom
:
- Semua platform:
fc
Format-Custom
dirancang untuk menampilkan tampilan yang bukan hanya tabel atau hanya daftar. Untuk menampilkan tampilan tabel alternatif, gunakan Format-Table
. Untuk menampilkan tampilan daftar alternatif, gunakan Format-List
.
Parameter GroupBy mengasumsikan bahwa objek diurutkan. Sebelum menggunakan Format-Custom
untuk mengelompokkan objek, gunakan Sort-Object
untuk mengurutkannya.