BatchFindInFiles メソッド (Editor オブジェクト)¶

指定するパスの複数のファイルから複数の文字列を検索します。検索したファイルの一覧は現在のウィンドウに表示されます。ファイルを保存していない場合は、ファイルを保存するかどうかを選択するメッセージボックスが表示されます。ユーザーが途中で処理を中止した場合、エラーを発生します。

¶

nFound = editor.BatchFindInFiles( filters, strPath, nFlags, [ nEncoding, [ strFilesToIgnore, [ nExFlags, [ nLimit ] ] ] ] );

nFound = editor.BatchFindInFiles( filters, strPath, nFlags, [ nEncoding, [ strFilesToIgnore, [ nExFlags, [ nLimit ] ] ] ] )

filters

検索文字列やフラグを含む Filters コレクションを指定します。

strPath

検索するパスを指定します。ここには、\* または ? のワイルドカードを含めて指定することができます。複数のファイルを指定する場合は、; で区切ります。

nFlags

次の値の組み合わせを指定します。


eeFindOpenDirect	ファイルから検索の結果を一覧としては表示せずに、検索文字列を含むファイルを直接開きます。eeFindOpenFilter または eeFindOutput と組み合わせて指定できません。
eeFindOpenFilter	ファイルから検索の結果を一覧としては表示せずに、検索文字列を含むファイルを直接開き、さらにフィルターに検索文字列を設定します。eeFindOpenDirect または eeFindOutput と組み合わせて指定できません。
eeFindOutput	ファイルから検索の場合、検索結果をアウトプットバーに表示します。eeFindOpenDirect または eeFindOpenFilter と組み合わせて指定できません。
eeFindRecursive	サブフォルダも検索します。
eeFindReplaceIgnoreFiles	strFilesToIgnore で指定する名前のファイルまたはフォルダを無視します。
eeFindSaveHistory	検索した文字列を履歴に保存します。
eeOpenDetectAll	すべて自動検出します。
eeOpenDetectCharset	HTML/XML の Charset を検出します。
eeOpenDetectUnicode	Unicode サイン (BOM) を検出します。
eeOpenDetectUTF8	UTF-8 を自動検出します。

さらに、次の値のどれか1つを指定することができます。


eeFindFileAndMatched	ファイル名と一致した文字列が結果として表示されます。
eeFindFileLineAndMatched	ファイル名、行番号、一致した文字列が結果として表示されます。
eeFindFileNamesOnly	見つかったファイルのファイル名だけを結果として表示し、検索した文字列を含む行の内容は表示しません。
eeFindLineOnly	検索した文字列を含む行の内容だけが結果として表示されます。
eeFindMatchedOnly	一致した文字列のみが結果として表示されます。

nEncoding

開くファイルのエンコードを指定します。エンコード定数から選択するか、または Windows で使用されるエンコードを指定します。0 を指定するか省略すると、検索されたファイル名に関連付けられている設定のプロパティに指定されているエンコードが使用されます。

strFilesToIgnore

nFlags に eeFindReplaceIgnoreFiles を指定した場合、無視するファイルまたはフォルダの名前を指定します。ここには、\* または ? のワイルドカードを含めて指定することができます。複数のファイルを指定する場合は、; で区切ります。

nExFlags

次の値の組み合わせを指定します。ただし、eeExFindRegexBoost、eeExFindRegexOnigmo、eeExFindRegexOnigmoPerl は、どれか1個のみ指定できます。どれも指定されない場合には、既定の正規表現エンジンを使用します。


eeExFindCountFrequency	結果より頻出文字列の表を作成します。eeFindLineOnly または eeFindMatchedOnly と組み合わせて使用します。
eeExFindMulti	一括検索を実行します。これが指定されていないと、連続検索を実行します。
eeExFindOutputEncoding	ファイル名にエンコード名を追加します。
eeExFindRegexBoost	正規表現エンジンとして Boost.Regex を使用します。
eeExFindRegexOnigmo	正規表現エンジンとして Onigmo を使用し、Ruby 構文を使用します。
eeExFindRegexOnigmoPerl	正規表現エンジンとして Onigmo を使用し、Perl 構文を使用します。

nLimit

一致の数がこの数字に到達すると、EmEditor はファイルの検索を終了します。0 を指定するか省略すると、EmEditor はファイルの検索を終了しません。

戻り値は検索したすべてのファイル内で一致した文字列を含む行数の合計になります。

EmEditor Professional Version 20.0 以上で利用できます。