PowerShell Alias - fc
 記事記号:[mcAc82] 初版:2010/Dec/28

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

名前
    Format-Custom
    
概要
    カスタマイズされたビューを使用して出力を書式設定します。
    
構文
    Format-Custom [[-Property] <Object[]>] [-Depth <int>] [-DisplayE
    rror] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObj
    ect <psobject>] [-ShowError] [-View <string>] [<CommonParamet
    ers>]
    
説明
    Format-Custom コマンドレットは、代替ビューの定義に従ってコマンドの出力を書式
    設定します。Format-Custom は表や一覧以外のビューも表示することができます。Wi
    ndows PowerShell ディレクトリの *format.PS1XML ファイルで定義されているビュ
    ーを使用できるほか、新しい PS1XML ファイルに作成した独自のビューを Update-Fo
    rmatData コマンドレットを使って Windows PowerShell に追加することも可能です。
    
パラメーター
    -Depth <int>
        表示する列の数を指定します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -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 パラメーターの値には、新しい集計プロパティを指定できます。集計
        プロパティを作成するには、ハッシュ テーブルを使用します。有効なキーは次
        のとおりです。
        
        -- Expression <string> または <script block>
        -- Depth <int32>
        
        必須                         false
        位置                         1
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -ShowError [<SwitchParameter>]
        パイプラインを介してエラーを送ります。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -View <string>
        代替形式の名前または "view" と指定します。このパラメーターを省略した場合、
        Format-Custom は既定のカスタム ビューを使用します。同じコマンド内で Prope
        rty パラメーターと View パラメーターを使用することはできません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    System.Management.Automation.PSObject
        パイプを使用してあらゆるオブジェクトを Format-Custom に渡すことができます。
    
出力
    Microsoft.PowerShell.Commands.Internal.Format
        Format-Custom は、表示を表す書式オブジェクトを返します。
    
メモ
        Format-Custom は表や一覧以外のビューも表示することができます。代替表ビュ
        ーを表示するには、Format-Table を使用します。代替一覧ビューを表示するには、
        Format-List を使用します。
        
        Format-Custom は、その組み込みエイリアスである "fc" で参照することもでき
        ます。詳細については、「about_Aliases」を参照してください。
        
        GroupBy パラメーターは、オブジェクトの並べ替えが済んでいることを前提とし
        ています。Format-Custom でグループ化する前に、Sort-Object を使用してオブ
        ジェクトを並べ替えます。
        
    -------------------------- 例 1 --------------------------
    C:\PS>get-command start-transcript | format-custom -view MyView
    
    説明
    -----------
    このコマンドは、Start-Transcript コマンドレットに関する情報をユーザー作成の
    カスタム ビューである MyView ビューに定義されている形式で書式設定します。こ
    のコマンドを正常に実行するには、最初に新しい PS1XML ファイルを作成し、MyView 
    ビューを定義しておき、作成した PS1XML ファイルを Update-FormatData コマンド
    を使用して Windows PowerShell に追加する必要があります。
    
    -------------------------- 例 2 --------------------------
    C:\PS>get-process Winlogon | format-custom
    
    説明
    -----------
    このコマンドは、Winlogon プロセスの情報を代替のカスタマイズされたビューで書
    式設定します。このコマンドでは View パラメーターが使用されていないため、For
    mat-Custom は既定のカスタム ビューを使用してデータを書式設定しています。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113301
	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Alias、fc
ご利用数: 1914051
感想・要望・問い合わせは こちら