Bagikan melalui

Format-Custom

Modul:
Microsoft.PowerShell.Utility Module

Menggunakan tampilan yang disesuaikan untuk memformat output.

Sintaks

Default (Default) 

Format-Custom
    [[-Property] <Object[]>]
    [-Depth <Int32>]
    [-GroupBy <Object>]
    [-View <String>]
    [-ShowError]
    [-DisplayError]
    [-Force]
    [-Expand <String>]
    [-InputObject <PSObject>]
    [<CommonParameters>]

Deskripsi

cmdlet Format-Custom memformat output perintah seperti yang didefinisikan dalam tampilan alternatif. Format-Custom dirancang untuk menampilkan tampilan yang bukan hanya tabel atau hanya daftar. Anda dapat menggunakan tampilan yang ditentukan di PowerShell, atau Anda bisa membuat tampilan Anda sendiri dalam file format.ps1xml baru dan menggunakan cmdlet Update-FormatData 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 cmdlet Start-Transcript 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 perintah Update-FormatData 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 kustom alternatif. Karena perintah tidak menggunakan parameter Tampilan , 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.

Properti parameter

Jenis:Int32
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

-DisplayError

Menampilkan kesalahan pada baris perintah. Parameter ini jarang digunakan, tetapi dapat digunakan sebagai bantuan penelusuran kesalahan saat Anda memformat ekspresi dalam perintah Format-Custom, dan ekspresi tampaknya tidak berfungsi.

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

-Expand

Memformat objek koleksi itu sendiri, serta objek-objek di dalam koleksi tersebut. 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.

Properti parameter

Jenis:String
Nilai default:EnumOnly
Nilai yang diterima:CoreOnly, EnumOnly, Both
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

-Force

Mengarahkan cmdlet untuk menampilkan semua informasi kesalahan. Gunakan dengan parameter DisplayError atau ShowError. Secara default, ketika sebuah objek kesalahan ditulis ke dalam aliran kesalahan atau aliran tampilan, hanya sebagian informasi kesalahan yang ditampilkan.

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

-GroupBy

Memformat output dalam grup berdasarkan properti atau nilai bersama. Masukkan ekspresi atau properti output. Parameter GroupBy mengharapkan objek diurutkan. Gunakan cmdlet Sort-Object sebelum menggunakan Format-Custom untuk mengelompokkan objek.

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 lebih lanjut, lihat tentang_Properti_Terhitung.

Properti parameter

Jenis:Object
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 yang akan diformat. Masukkan variabel yang berisi objek atau ketik perintah atau ekspresi yang mendapatkan objek.

Properti parameter

Jenis:PSObject
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:True
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Property

Menentukan properti objek yang muncul dalam tampilan dan urutan munculnya. Kartu liar diizinkan.

Jika Anda menghilangkan parameter ini, properti yang muncul di tampilan bergantung pada objek yang ditampilkan. Nama parameter untuk Properti bersifat opsional. Anda tidak dapat menggunakan properti dan parameter 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>
  • Kedalaman - <int32>

Untuk informasi lebih lanjut, lihat tentang_Properti_Terhitung.

Properti parameter

Jenis:

Object[]

Nilai default:None
Mendukung wildcard:True
DontShow:False

Set parameter

(All)
Position:0
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ShowError

Mengirimkan kesalahan melalui jalur pemrosesan. Parameter ini jarang digunakan, tetapi dapat digunakan sebagai bantuan penelusuran kesalahan saat Anda memformat ekspresi dalam perintah Format-Custom, dan ekspresi tampaknya tidak berfungsi.

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

-View

Menentukan nama format atau tampilan alternatif. Jika Anda menghilangkan parameter ini, Format-Custom menggunakan tampilan kustom default. Anda tidak dapat menggunakan properti dan parameter tampilan dalam perintah yang sama.

Properti parameter

Jenis:String
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

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

PSObject

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.