BatchReplaceInFiles 方法 (Editor 对象)

在多个文件中替换多个字符串。

[JavaScript]

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

[VBScript]

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

参数

filters

指定包含搜索字符串和标志的 Filters 集合。

strPath

指定要搜索的路径。它可以包括通配符，例如\* 以及 ?。

nFlags

指定一个下列值的组合。

eeFindRecursive	在指定路径的子文件夹中搜索。
eeFindReplaceIgnoreFiles	忽略由 strFilesToIgnore 指定的文件或文件夹。
eeOpenDetectAll	检测所有编码。
eeOpenDetectCharset	检测 HTML/XML 字符集。
eeOpenDetectUnicode	检测 Unicode 签名 (BOM)。
eeOpenDetectUTF8	检测 UTF-8。
eeReplaceBackup	保存备份。不能与 eeReplaceKeepOpen 合用。
eeReplaceKeepOpen	保持修改的文件为打开状态。不能与 eeReplaceBackup 合用。

nEncoding

从 编码常数 中选择或指定任何用于 Windows 操作系统的代码页。如果指定 0 或省略，将使用与搜索的文件名关联的配置属性中指定的编码。

strFilesToIgnore

如果 nFlags 包括 eeFindReplaceIgnoreFiles，指定要忽略的文件或文件夹名称。它可以包括通配符，例如 * 和 ?。要指定多个文件，用分号 (;) 来隔开文件。

strBackupPath

指定备份文件夹如果 nFlags  指定了 eeReplaceBackup。

nExFlags

指定下列值的组合。但是，只能指定 eeExFindRegexBoost，eeExFindRegexOnigmo 和 eeExFindRegexOnigmoPerl 中的一个。如果不指定，则使用默认的正则表达式引擎。

eeExFindMulti	执行 多项替换全部。如果未指定，则执行 批处理替换全部。详情请参阅 批处理替换全部和多项替换全部之间的区别。
eeExFindRegexBoost	使用 Boost.Regex 作为正则表达式引擎。
eeExFindRegexOnigmo	使用 Onigmo 作为正则表达式引擎，Ruby 语法。
eeExFindRegexOnigmoPerl	使用 Onigmo 作为正则表达式引擎，Perl 语法。

nLimit

当匹配数达到此数字时，EmEditor 将停止搜索文件。 如果指定 0，则 EmEditor 不会停止搜索文件。

返回值

返回值是在所有搜索的文件中替换的字符串总数。

备注

除非 nFlags  指定 eeReplaceKeepOpen，否则无法撤消此操作。 建议将 eeReplaceBackup 指定为 nFlags  并保存备份。 如果备份文件夹中存在相同的文件名，则新备份将覆盖旧文件。

版本

支持 EmEditor Professional 20.0 或之后的版本。