cheshire-boy

コマンドヘルプ集

コマンドレット説明書【Select-String】の使い方 (PowerShell v5.1)

投稿日:2017年3月7日 更新日:

こんにちは。チェシャ男です。(-皿-)

今回は、Select-String について概要から使用例について簡単にご紹介します。

コマンドレットリファレンス」カテゴリの記事では省略している情報を参照したい場合に本記事をご覧ください。

スポンサーリンク

はじめに

本記事は英語のリファレンス情報しかないコマンドレットについて「Get-Help」等の情報を参考に検証した結果を掲載しています。公式見解ではないことにご注意ください。

正式なヘルプを参照したい場合は、「Get-help Select-String -online」を実行し公式ヘルプをご覧ください。

また、本記事内の例は動作を確認していますが、動作を確約しているわけではありません。

Select-String の概要

Select-String は文字列やファイル内のテキストから任意のパターンを検索します。

基本構文

[]で囲まれたパラメーターは任意のオプションです。
{}で囲まれた箇所は要素を選択してください。
<>で囲まれた箇所はオブジェクトの型名を示しています。

動作の説明

Select-String は、入力文字列やファイル内のテキストから任意の文字列パターンを検索します。UNIX での「Grep」および Windows での「Findstr」のように使用することができます。

Select-String はエイリアスとして「SLS」を使用することができます。

既定では各行で最初の一致を検索し、一致する度に

ファイル名」:「行番号」:「一致を含む行内のすべてのテキスト

を表示します。

行内に複数の一致があった場合は、一致の前後のテキストを表示するか、一致が検出されたかどうかを示す bool 値(true または false)のみを表示するように指定することができます。

また、すべてのテキストの一致を表示することや各入力ファイル内の最初の一致の後に停止することもできます。指定したパターンに一致しないすべてのテキストを表示することもできます。

Unicode テキストファイルを検索する場合などは、Select-String が特定の文字エンコーディングに合わせて動作するように指定することができます。

各パラメータについて

-AllMatches [<SwitchParameter>]

各行で2つ以上の一致を検索します。このオプションを指定しないと各テキスト行で最初の一致のみを検索します

-CaseSensitive [<SwitchParameter>]

照合で大文字と小文字を区別します。既定では、照合時に大文字と小文字は区別されません。

-Context <Int32[]>

一致した行の前後の行を指定された行数で表示します。これによりコンテキスト(前後の文脈)で一致を表示することができます。

このオプションの値として数値を1つ設定すると、その数値が一致した行の前後で表示される行数となります。値として数値を2つ設定すると、最初の数値が一致の前の行数となり、2番目の数値が一致の後の行数となります。

既定の表示方法では、一致した行に右山かっこ">"が表示されます。マークが表示されていない行はコンテキストです。

コンテキストにも一致が含まれている場合、各一致を表す MatchInfo オブジェクトにはすべてのコンテキスト行が含まれますが、重複する一致行は1回だけ表示されます。

Select-String の出力を再び Select-String にパイプするとき、受信側の Select-String はコンテキスト行内のテキストは検索せず、一致した行内のテキスト(MatchInfo オブジェクトの Line プロパティの値)のみを検索します。

そのため、Context オプションは受信側の Select-String では無効です。

-Encoding <String>

ファイルを検索するときに、Select-String が使用する文字エンコードを指定します。既定値は「UTF-8」です。

設定可能な有効値
UTF7 , UTF8 , UTF32 , ASCII , Unicode , BigEndianUnicode , Default , OEM

"Default"は、システムの現在の ANSI コードページのエンコードです。"OEM" は、オペレーティングシステムの現在の OEM (Original Equipment Manufacturer) コードページ識別子です。

-Exclude <String[]>

指定された項目を除外します。このオプションの値は"-Path"オプションの補足として使用します。「*.txt」のようにワイルドカードを使用してパス要素またはパターンを設定できます。

-Include <String[]>

指定した項目だけを含めます。このオプションの値は"-Path"オプションの補足として使用します。「*.txt」のようにワイルドカードを使用してパス要素またはパターンを設定できます。

-InputObject <PSObject>

検索するテキスト(オブジェクト)を指定します。テキストが格納されている変数を設定するか、結果を取得するコマンドレットまたは式(関数等)を設定します。

InputObject オプションを使用する場合は、文字列を Select-String にパイプ処理する場合と以下のように異なります。

■Select-String に2つ以上の文字列(コレクション)をパイプ処理する時...

Select-String は各文字列について指定されたテキストを検索し、検索テキストを含む各文字列を返します。

■InputObjectオプションを使用して、文字列(コレクション)を送信する時...

Select-String は1つの結合された文字列としてコレクションを処理し、任意の文字列で検索テキストが見つかった場合は、1つのユニットとして文字列を返します。

-List [<SwitchParameter>]

入力ファイルごとに最初の一致のみを返します。既定では、Select-String は一致が見つかる度に MatchInfo オブジェクトを返します。

-NotMatch [<SwitchParameter>]

指定したパターンに一致しないテキストを検索します。

-Path <String[]>

検索するファイルへのパスを指定します。ワイルドカードを使用できます。

"Log1.txt"や"* .doc"、"*. *" などで、ディレクトリ内のファイルを指定します。ディレクトリのみを指定するとコマンドレットは失敗します。

-Pattern <String[]>

検索するテキストを指定します。文字列または正規表現を入力します。文字列を入力する場合は、SimpleMatch オプションを使用します。

-Quiet [<SwitchParameter>]

MatchInfo オブジェクトの代わりに bool 値( true または false )を返します。パターンが見つかった場合、値は「true」でそれ以外の場合、値は「false」です。

-SimpleMatch [<SwitchParameter>]

正規表現照合ではなく単純な照合を使用します。単純な照合では、"-Pattern"オプション内のテキスト用の入力を検索します。

-LiteralPath <String[]>

検索するファイルへのパスを指定します。Path と異なり、LiteralPath オプションの値は入力したとおりに使用されます。ワイルドカードとして解釈される文字はありません。パスにエスケープ文字が含まれている場合は、単一引用符で囲んで使用します。

<CommonParameters>

このコマンドレットでは、

Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer、PipelineVariable、OutVariable

の各共通パラメーターを使用することができます。

入力値

System.Management.Automation.PSObject

(ToString メソッドを伴う任意のオブジェクトを Select-String へパイプ処理することができます。)

出力値

Microsoft.PowerShell.Commands.MatchInfo
System.Boolean

(既定では一致するごとに1つずつの MatchInfo オブジェクトを出力します。Quiet オプションを使用した場合、出力はパターンが見つかったかどうかを示す Bool値です。)

備考

Select-String は UNIX の Grep コマンドおよび Windows の FindStr コマンドに似ています。エイリアスの "sls" は、PowerShell 3.0 で導入されました。

Select-String では、検索する対象のテキストファイルオブジェクト入力値として使用します。検索する対象は以下のいずれかの方法で指定します。

  • 引用符で囲まれた文字列内のテキストを入力し、Select-String にパイプ処理します。
  • テキスト文字列を変数に格納し、InputObject オプションの値として、変数を指定します。
  • テキストがファイルに格納されている場合は、Path オプションを使用して、ファイルへのパスを指定します。

Select-String の既定の出力は、MatchInfo オブジェクトで、一致に関する詳細な情報が含まれています。MatchInfo のオブジェクトには FilenameLine などのプロパティが含まれるため、オブジェクト内の情報は、ファイル内のテキストを検索するときに役立ちます。
※入力がファイルから取得したものでない場合、これらのオプションの値は "InputStream" になります

MatchInfo オブジェクト内の情報が必要ない場合は、Quiet オプションを使用します。このオプションは、MatchInfo オブジェクトではなく、一致が見つかったかどうかを示す bool 値 (true または false) を返します。

Select-String は、語句の照合時にシステムに設定されている現在のカルチャを使用します。現在のカルチャを検索するには、Get-Culture コマンドレットを使用します。

使用例

例1:大文字と小文字を区別して検索する

この例では、Select-String コマンドにパイプされたテキストの大文字と小文字を区別した照合を実行します。

その結果、"Hello" は一致しないため、Select-String は "HELLO" のみを検索します。

CaseSensitive オプションがない場合、引用符で囲まれた文字列はそれぞれ 1 行として扱われるため、Select-String は両方の文字列を一致として認識します。

例2:条件に一致したファイル内を検索する

この例では、現在のディレクトリ内の .xml ファイル名拡張子を持つすべてのファイルを検索し、それらのファイル内の文字列 "the the" を含む行を表示します。。

例3:自動変数を使用してパスを指定する

この例では、PowerShell の概念的なヘルプファイルで"Help"を含む情報を検索します。

この例ではパスを指定するために $pshome 自動変数の値を使用しています。この変数は PowerShell のインストールディレクトリへのパス情報を格納します。

例4:イベントログのメッセージを検索する

この例では、イベント ビューアーのアプリケーション ログにおける 100 個の最新のイベントで、文字列 "不可" を検索します。

最初のコマンドは、Get-EventLog コマンドレットを使用して、アプリケーション イベント ログから、100 個の最新のイベントを取得します。その後、イベントを $events 変数に格納します。

2 番目のコマンドは、パイプライン演算子 (|) を使用して $events 変数内のオブジェクトを Select-String に渡します。$events 変数からの入力を表すために、InputObject オプションを使用します。InputObject オプションの値は、パイプラインを介してやり取りする際の、各オブジェクトの Message プロパティです。

例5:複数ファイルをまとめて検索する

この例では、C:\Windows\System32 のディレクトリ配下にある「~.txt」拡張子のファイルをすべて調べ、文字列 "Microsoft" を検索しています。

CaseSensitive オプションは、Select-String で一致を見つけるためには、"Microsoft" の "M" が大文字で、他の文字は小文字である必要があることを示します。

例6:一致しないプロセスを検索する

この例では、Process.txt ファイルで、単語 "idle" または "svchost" を含まないテキスト行を検索します。

スポンサーリンク

-コマンドヘルプ集
-, , ,

Copyright© 【チェシャわら】PowerShellとは、から学ぶ入門者の教科書-脱コマンドプロンプト- , 2018 AllRights Reserved Powered by micata2.