Regex.Escape メソッド

.NET Framework クラス ライブラリ リファレンス

Regex.Escape メソッド

メタ文字 (\、*、+、?、|、{、[、(、)、^、$、.、#、および空白) をエスケープ コードに置き換えることにより、それらのメタ文字をエスケープします。

名前空間: System.Text.RegularExpressions
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Shared Function Escape
 ( _
    str As String _
) As String

Visual Basic (使用法)

Dim str As String
Dim returnValue As String

returnValue = Regex.Escape(str)

C#

public static string Escape
 (
    string str
)

C++

public:
static String^ Escape (
    String^ str
)

J#

public static String Escape (
    String str
)

JScript

public static function Escape
 (
    str : String
) : String

パラメータ

str

変換対象のテキストを含んでいる入力文字列。

戻り値
エスケープされた形に変換されたメタ文字を含んでいる文字列。

解説

Escape は文字列を正規表現内で定数として使用できるように変換します。IgnorePatternWhitespace オプションを有効にして解析される正規表現内で文字列を使用できるようにするには、シャープ記号 (#) および空白文字をエスケープする必要があります。将来の .NET 正規表現機能で他のメタ文字が追加された場合、Escape はそれらの文字もエスケープされた形式に変換します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Regex クラス
Regex メンバ
System.Text.RegularExpressions 名前空間