Bagikan melalui

Format-List

  • Referensi
Modul:
Microsoft.PowerShell.Utility

Memformat output sebagai daftar properti tempat setiap properti muncul pada baris baru.

Sintaks

Format-List
      [[-Property] <Object[]>]
      [-GroupBy <Object>]
      [-View <string>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <string>]
      [-InputObject <psobject>]
      [<CommonParameters>]

Deskripsi

Format-List Cmdlet memformat output perintah sebagai daftar properti tempat setiap properti ditampilkan pada baris terpisah. Anda dapat menggunakan Format-List untuk memformat dan menampilkan semua atau properti objek yang dipilih sebagai daftar (Format-List -Property *).

Karena lebih banyak ruang tersedia untuk setiap item dalam daftar daripada dalam tabel, PowerShell menampilkan lebih banyak properti objek dalam daftar, dan nilai properti cenderung tidak terpotong.

Contoh

Contoh 1: Memformat layanan komputer

Get-Service | Format-List

Perintah ini memformat informasi tentang layanan pada komputer sebagai daftar. Secara default, layanan diformat sebagai tabel. Get-Service Cmdlet mendapatkan objek yang mewakili layanan di komputer. Operator alur (|) meneruskan hasil melalui alur ke Format-List. Kemudian, Format-List perintah memformat informasi layanan dalam daftar dan mengirimkannya ke cmdlet output default untuk ditampilkan.

Contoh 2: Memformat file PS1XML

Perintah ini menampilkan informasi tentang file PS1XML di direktori PowerShell sebagai daftar.

$A = Get-ChildItem $pshome\*.ps1xml
Format-List -InputObject $A

Perintah pertama mendapatkan objek yang mewakili file dan menyimpannya dalam $A variabel.

Perintah kedua menggunakan Format-List untuk memformat informasi tentang objek yang disimpan di $A. Perintah ini menggunakan parameter InputObject untuk meneruskan variabel ke Format-List, yang kemudian mengirim output yang diformat ke cmdlet output default untuk ditampilkan.

Contoh 3: Memformat properti proses berdasarkan nama

Perintah ini menampilkan nama, prioritas dasar, dan kelas prioritas dari setiap proses pada komputer.

Get-Process | Format-List -Property Name, BasePriority, PriorityClass

Ini menggunakan Get-Process cmdlet untuk mendapatkan objek yang mewakili setiap proses. Operator alur (|) meneruskan objek proses melalui alur ke Format-List. Format-List memformat proses sebagai daftar properti yang ditentukan. Nama parameter Properti bersifat opsional, sehingga Anda dapat menghilangkannya.

Contoh 4: Memformat semua properti untuk proses

Perintah ini menampilkan semua properti proses Winlogon.

Get-Process winlogon | Format-List -Property *

Ini menggunakan cmdlet Get-Process untuk mendapatkan objek yang mewakili proses Winlogon. Operator alur (|) meneruskan objek proses Winlogon melalui alur ke Format-List. Perintah menggunakan parameter Properti untuk menentukan properti dan * untuk menunjukkan semua properti. Karena nama parameter Properti bersifat opsional, Anda dapat menghilangkannya dan mengetik perintah sebagai Format-List *. Format-List secara otomatis mengirim hasil ke cmdlet output default untuk ditampilkan.

Contoh 5: Pemecahan masalah kesalahan format

Contoh berikut menunjukkan hasil penambahan parameter DisplayError atau ShowError dengan ekspresi.

PC /> Get-Date | Format-List DayOfWeek,{ $_ / $null } -DisplayError

DayOfWeek    : Friday
 $_ / $null  : #ERR

PC /> Get-Date | Format-List DayOfWeek,{ $_ / $null } -ShowError

DayOfWeek    : Friday
 $_ / $null  :

Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 7:59:23 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

Parameter

-DisplayError

Menunjukkan bahwa cmdlet ini menampilkan kesalahan pada baris perintah. Parameter ini jarang digunakan, tetapi dapat digunakan sebagai bantuan penelusuran kesalahan saat Anda memformat ekspresi dalam Format-List perintah, dan ekspresi tampaknya tidak berfungsi.

Jenis:SwitchParameter
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Expand

Menentukan objek koleksi yang diformat, serta objek dalam koleksi. Parameter ini dirancang untuk memformat objek yang mendukung antarmuka System.Collections.ICollection . Nilai defaultnya adalah EnumOnly. Nilai yang dapat diterima untuk parameter ini adalah:

  • EnumOnly. Menampilkan properti objek dalam koleksi.
  • CoreOnly. Menampilkan properti objek koleksi.
  • Both. Menampilkan properti objek koleksi dan properti objek dalam koleksi.
Jenis:String
Nilai yang diterima:CoreOnly, EnumOnly, Both
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Force

Menunjukkan bahwa cmdlet ini 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.

Juga diperlukan saat memformat jenis .NET tertentu. Untuk informasi selengkapnya, lihat bagian Catatan.

Jenis:SwitchParameter
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-GroupBy

Menentukan 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:

  • Name (atau Label) - <string>
  • Expression - <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:

  • Name (atau Label) - <string>
  • Expression - <string> atau <script block>
  • FormatString - <string>

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

Menunjukkan bahwa cmdlet mengirim kesalahan melalui alur. Parameter ini jarang digunakan, tetapi dapat digunakan sebagai bantuan penelusuran kesalahan saat Anda memformat ekspresi dalam Format-List 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 daftar alternatif. 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

PSObject

Anda dapat menyalurkan objek apa pun ke cmdlet ini.

Output

Microsoft.PowerShell.Commands.Internal.Format

Cmdlet ini mengembalikan objek format yang mewakili daftar.

Catatan

PowerShell menyertakan alias berikut untuk Format-List:

  • Semua platform:
    • fl

Cmdlet format, seperti Format-List, atur data yang akan ditampilkan tetapi jangan tampilkan. Data ditampilkan oleh fitur output PowerShell dan oleh cmdlet yang berisi Out kata kerja ( Out cmdlet), seperti Out-Host atau Out-File.

Jika Anda tidak menggunakan cmdlet format, PowerShell menerapkan format default tersebut untuk setiap objek yang ditampilkannya.

Parameter GroupBy mengasumsikan bahwa objek diurutkan. Gunakan Sort-Object sebelum menggunakan Format-List untuk mengelompokkan objek.

Parameter Tampilan memungkinkan Anda menentukan format alternatif untuk tabel. Anda dapat menggunakan tampilan yang ditentukan dalam *.format.PS1XML file di direktori PowerShell, atau Anda dapat membuat tampilan Anda sendiri dalam file PS1XML baru dan menggunakan Update-FormatData cmdlet untuk menyertakannya di PowerShell.

Tampilan alternatif untuk parameter Tampilan harus menggunakan format daftar, jika tidak, perintah gagal. Jika tampilan alternatif adalah tabel, gunakan Format-Table. Jika tampilan alternatif bukan daftar atau tabel, gunakan Format-Custom.

Jika Anda ingin menggunakan Format-List dengan parameter Properti, Anda perlu menyertakan parameter Paksa dalam salah satu kondisi berikut: