PowerShell Alias - fl
 記事記号:[mcAc83] 初版:2010/Dec/28

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Format-List
    
概要
    出力は、各プロパティを個別の行に表示するプロパティの一覧に書式設定されます。
    
構文
    Format-List [[-Property] <Object[]>] [-DisplayError] [-Expand <stri
    ng>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] 
    [-ShowError] [-View <string>] [<CommonParameters>]
    
説明
    Format-List コマンドレットは、コマンドの出力をプロパティの一覧に書式設定しま
    す。各プロパティはそれぞれ個別の行に表示されます。Format-List を使用すると、
    オブジェクトのプロパティをすべてまたは選択して一覧表示し書式設定できます (fo
    rmat-list *)。
    
    一覧の方が表よりも各項目に多くのスペースを使用できるため、Windows PowerShell 
    で表示される一覧の方が、オブジェクトのプロパティが多く表示され、プロパティ値
    が切り詰められる可能性が低くなります。
    
パラメーター
    -DisplayError [<SwitchParameter>]
        エラーをコマンド ラインに表示します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Expand <string>
        コレクション オブジェクトおよびコレクション内のオブジェクトを書式設定し
        ます。このパラメーターは、ICollection (System.Collections) インターフェ
        イスをサポートするオブジェクトを書式設定するために用意されました。既定値
        は EnumOnly です。
        
        有効な値は次のとおりです。
        -- EnumOnly: コレクション内のオブジェクトのプロパティを表示します。
        -- CoreOnly: コレクション オブジェクトのプロパティを表示します。
        -- Both: コレクション オブジェクトのプロパティおよびコレクション内のオブ
        ジェクトのプロパティを表示します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        コマンドレットにすべてのエラー情報を表示するよう指示します。DisplayError 
        パラメーターまたは ShowError パラメーターと共に使用します。既定では、エラ
        ー オブジェクトがエラーまたは表示ストリームに書き込まれたとき、一部のエラ
        ー情報だけが表示されます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -GroupBy <Object>
        共有プロパティまたは値を基にグループ化した単位で出力の書式設定を行います。
        出力の式またはプロパティを入力します。
        
        GroupBy パラメーターの値には、新しい集計プロパティを指定できます。集計プ
        ロパティを作成するには、ハッシュ テーブルを使用します。有効なキーは次の
        とおりです。
        
        -- Name (または Label) <string>
        -- Expression <string> または <script block>
        -- FormatString <string>
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -InputObject <psobject>
        書式設定するオブジェクトを指定します。オブジェクトが格納されている変数を
        入力するか、オブジェクトを取得するコマンドまたは式を入力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByValue)
        ワイルドカード文字を許可する false
        
    -Property <Object[]>
        表示するオブジェクト プロパティとその表示順序を指定します。ワイルドカー
        ドを使用できます。
        
        このパラメーターを省略した場合、表示されるプロパティが、表示されるオブジ
        ェクトごとに異なります。パラメーター名 ("Property") はオプションです。同
        じコマンド内で Property パラメーターと View パラメーターを使用することは
        できません。
        
        Property パラメーターの値には、新しい集計プロパティを指定できます。集計
        プロパティを作成するには、ハッシュ テーブルを使用します。有効なキーは次
        のとおりです。
        
        -- Name (または Label) <string>
        -- Expression <string> または <script block>
        -- FormatString <string>
        
        必須                         false
        位置                         1
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -ShowError [<SwitchParameter>]
        パイプラインを介してエラーを送ります。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -View <string>
        代替一覧形式の名前または "view" と指定します。同じコマンド内で Property 
        パラメーターと View パラメーターを使用することはできません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    System.Management.Automation.PSObject
        パイプを使用して、あらゆるオブジェクトを Format-List に渡すことができま
        す。
    
出力
    Microsoft.PowerShell.Commands.Internal.Format
        Format-List は、一覧を表す書式オブジェクトを返します。
    
メモ
        Format-List は、その組み込みエイリアスである "FL" で参照することもできま
        す。詳細については、「about_Aliases」を参照してください。
        
        Format-List などの書式設定コマンドレットは、表示するデータを編成しますが、
        表示は行いません。データの表示は、Windows PowerShell の出力機能および Out 
        コマンドレット (Out-Host、Out-File、Out-Printer など、Out を動詞とするコ
        マンドレット) によって行われます。
        
        書式設定コマンドレットを使用しない場合、Windows PowerShell では表示対象の
        各オブジェクトに既定の形式が適用されます。
        
        GroupBy パラメーターは、オブジェクトの並べ替えが済んでいることを前提とし
        ています。Format-Custom でグループ化する前に、Sort-Object を使用してオブ
        ジェクトを並べ替えます。
        
        View パラメーターを使用すると、表の代替形式を指定できます。Windows Power
        Shell ディレクトリの *.format.PS1XML ファイルで定義されているビューを使用
        できるほか、新しい PS1XML ファイルに作成した独自のビューを Update-Format
        Data コマンドレットを使って Windows PowerShell に追加することも可能です。
        
        View パラメーターに指定する代替ビューは、一覧形式でなければなりません。
        一覧形式でない場合、コマンドは失敗します。代替ビューが表の場合は、Format-
        Table を使用します。代替ビューが一覧と表のどちらでもない場合は、Format-Cu
        stom を使用します。
        
    -------------------------- 例 1 --------------------------
    C:\PS>get-service | format-list
    
    説明
    -----------
    このコマンドは、コンピューター上のサービスに関する情報を一覧として書式設定し
    ます。既定では、このサービスは表として書式設定されます。Get-Service コマンド
    レットは、コンピューター上のサービスを表すオブジェクトを取得します。パイプラ
    イン演算子 (|) は、パイプラインを介して Format-List に結果を渡します。次に、
    Format-List コマンドがサービス情報を一覧で書式設定し、表示するために既定の出
    力コマンドレットに送ります。
    
    -------------------------- 例 2 --------------------------
    C:\PS>$a = get-childitem $pshome\*.ps1xml
    
    説明
    -----------
    これらのコマンドは、Windows PowerShell ディレクトリの PS1XML ファイルに関す
    る情報を一覧形式で表示します。最初のコマンドは、ファイルを表すオブジェクトを
    取得し、$a 変数に保存しています。2 番目のコマンドは、Format-List を使用して、
    $a に保存されているオブジェクトに関する情報を書式設定しています。このコマン
    ドは、InputObject パラメーターを使用して変数を Format-List に渡します。変数
    を受け取った Format-List は書式設定された出力を表示するために既定の出力コマ
    ンドレットに送ります。
    
    -------------------------- 例 3 --------------------------
    C:\PS>get-process | format-list -property name, basepriority, prioritycla
    ss
    
    説明
    -----------
    このコマンドは、コンピューター上の各プロセスの名前、基本優先度、および優先度
    クラスを表示します。Get-Process コマンドレットを使用して、各プロセスを表すオ
    ブジェクトを取得します。パイプライン演算子 (|) は、パイプラインを介して Form
    at-List にプロセス オブジェクトを渡します。Format-List は、指定されたプロパ
    ティの一覧形式でプロセスを書式設定します。パラメーター名 "Property" はオプシ
    ョンであるため、省略できます。
    
    -------------------------- 例 4 --------------------------
    C:\PS>get-process winlogon | format-list -property *
    
    説明
    -----------
    このコマンドは、Winlogon プロセスのすべてのプロパティを表示します。Get-Proce
    ss コマンドレットを使用して、Winlogon プロセスを表すオブジェクトを取得します。
    パイプライン演算子 (|) は、パイプラインを介して Format-List に Winlogon プロ
    セス オブジェクトを渡します。このコマンドの Property パラメーターには、すべ
    てのプロパティを表す * が指定されています。Property パラメーターの名前はオプ
    ションであるため、「format-list *」のように省略できます。Format-List は、結
    果を表示するために既定の出力コマンドレットに自動的に送ります。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113302
	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Alias、fl
ご利用数: 1862279
感想・要望・問い合わせは こちら