PowerShell Cmdlet - Out-String
 記事記号:[mg1945] 初版:2011/Sep/30

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

名前
    Out-String
    
概要
    オブジェクトを一連の文字列としてホストに送ります。
    
構文
    Out-String [-InputObject <psobject>] [-Stream] [-Width <int>] [<CommonParame
    ters>]
    
説明
    Out-String コマンドレットは、Windows PowerShell が管理するオブジェクトを文字
    列の配列に変換します。既定では、Out-String は文字列をまとめて単一の文字列と
    して返しますが、stream パラメーターを使用すると、文字列を一度に 1 つずつ返す
    よう Out-String に指示することができます。オブジェクト操作が煩雑である場合は、
    このコマンドレットを使用して、従来のシェルと同じ方法で文字列出力の検索および
    操作を行うことができます。
    
パラメーター
    -InputObject <psobject>
        文字列に書き込むオブジェクトを指定します。オブジェクトが格納されている変
        数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByValue)
        ワイルドカード文字を許可する false
        
    -Stream [<SwitchParameter>]
        オブジェクトごとに文字列を送ります。既定では、各オブジェクトの文字列は単
        一の文字列にまとめられて送られます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Width <int>
        出力行の文字数を指定します。この文字数を超えた場合、それ以降の文字は折り
        返されずに切り捨てられます。このパラメーターを省略した場合、行の幅はホス
        トの特性で決定されます。PowerShell.exe ホストの既定値は 80 (文字) です。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    System.Management.Automation.PSObject
        パイプを使用して、オブジェクトを Out-String に渡すことができます。
    
出力
    System.String
        Out-String は、入力オブジェクトから作成した文字列を返します。
    
メモ
        Out という動詞を含むコマンドレット (Out コマンドレット) はオブジェクトを
        書式設定しません。オブジェクトをレンダリングし、指定された表示先に送るだ
        けです。書式設定されていないオブジェクトを Out コマンドレットに送ると、O
        ut コマンドレットはこのオブジェクトをレンダリングする前に書式設定用コマ
        ンドレットに送ります。
        
        Out コマンドレットには、名前またはファイル パス用のパラメーターがありま
        せん。Out コマンドレットにデータを送るには、Windows PowerShell コマンド
        の出力をコマンドレットに送るパイプライン演算子 (|) を使用します。InputOb
        ject パラメーターを使用すると、変数に保存したデータをコマンドレットに渡
        すこともできます。詳細については、例を参照してください。
    
    -------------------------- 例 1 --------------------------
    
    C:\PS>get-content C:\test1\testfile2.txt | out-string
    
    説明
    -----------
    このコマンドは、Testfile2.txt ファイルの内容を単一の文字列としてコンソールに
    送ります。Get-Content コマンドレットを使用してファイルの内容を取得しています。
    取得されたファイルの内容はパイプライン演算子 (|) によって Out-String に送ら
    れ、単一の文字列としてコンソールに送られます。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>$c = get-culture | select-object *
    
    C:\PS> out-string -inputobject $c -width 100
    
    説明
    -----------
    これらのコマンドは、現在のユーザーの地域設定を取得し、そのデータを文字列に変
    換します。最初のコマンドは、Get-Culture コマンドレットを使用して地域設定を取
    得します。結果はパイプライン演算子 (|) によって Select-Object コマンドレット
    に送られ、Get-Culture が取得したカルチャ オブジェクトのすべて (*) のプロパテ
    ィが選択されます。次に、選択されたプロパティが $c 変数に保存されます。
    
    2 番目のコマンドは、Out-String を使用して、CultureInfo オブジェクトを一連の
    文字列に変換します (プロパティごとに 1 つの文字列に変換されます)。また、Inpu
    tObject パラメーターを使用して Out-String に $c 変数を渡します。文字列が切り
    詰められないよう、width パラメーターは 1 行あたり 100 文字に設定されています。
    
    -------------------------- 例 3 --------------------------
    
    C:\PS>get-alias | out-string -stream | select-string "Get-Command"
    
    説明
    -----------
    このコマンドは、"Get-Command" という語句を含むエイリアスを表示します。このコ
    マンドは、Get-Alias コマンドレットを使用して一連の AliasInfo オブジェクトを
    取得します (現在のセッションのエイリアスごとに 1 つ取得します)。この例は、オ
    ブジェクトの操作と文字列の操作の違いを示しています。
    
    Get-Alias の出力はパイプライン演算子 (|) によって Out-String に送られ、オブ
    ジェクトが一連の文字列に変換されます。Stream パラメーターを指定しているため、
    文字列は単一の文字列にまとめられるのではなく、文字列ごとに個別に送られます。
    もう 1 つのパイプライン演算子では、文字列が Select-String に送られ、"Get-Comm
    and" を含む文字列が選択されています。
    
    Stream パラメーターを省略した場合、Out-String が返す単一の文字列内に "Get-Com
    mand" があることを Select-String が見つけるため、すべてのエイリアスが表示され、
    文字列は表形式で表示されます。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113368
    Out-File 
    Out-Null 
    Out-Host 
    Out-Printer 
    Out-Default 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Out-String
ご利用数: 1969101
感想・要望・問い合わせは こちら