EncodingHelper.GetEncoding メソッド

[アーティクル]
08/09/2011

指定されたファイルのエンコーディングをファイルのバイト順マークから判断します。

名前空間: Microsoft.VisualStudio.TextTemplating
アセンブリ: Microsoft.VisualStudio.TextTemplating.10.0 (Microsoft.VisualStudio.TextTemplating.10.0.dll 内)

構文

'宣言
Public Shared Function GetEncoding ( _
    filePath As String _
) As Encoding

public static Encoding GetEncoding(
    string filePath
)

public:
static Encoding^ GetEncoding(
    String^ filePath
)

static member GetEncoding : 
        filePath:string -> Encoding

public static function GetEncoding(
    filePath : String
) : Encoding

パラメーター

filePath
型: System.String
エンコーディングを判断するファイル。

戻り値

型: System.Text.Encoding
エンコーディング情報を格納する Encoding。既定値は、システムの現在の ANSI コードページの Default です。

例外

例外	条件
ArgumentNullException	filePath は nullnull 参照 (Visual Basic では Nothing) なので、

解説

ユーザーがテキストテンプレートを作成すると、生成されたテキストを作成するのにテキストテンプレートのホストが使用する、エンコードを指定することができます。ユーザーがエンコーディングを指定しない場合、ホストはこのメソッドを呼び出して、テキストテンプレートのエンコーディングを判定します。その後、ホストは同じエンコーディングを使用して、生成されたテキストを作成することができます。