ITextTemplatingEngineHost.LogErrors メソッド
変換エンジンからエラーおよび警告のコレクションを受け取ります。
名前空間: Microsoft.VisualStudio.TextTemplating
アセンブリ: Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll 内)
構文
'宣言
Sub LogErrors ( _
errors As CompilerErrorCollection _
)
void LogErrors(
CompilerErrorCollection errors
)
void LogErrors(
CompilerErrorCollection^ errors
)
abstract LogErrors :
errors:CompilerErrorCollection -> unit
function LogErrors(
errors : CompilerErrorCollection
)
パラメーター
- errors
型 : System.CodeDom.Compiler.CompilerErrorCollection
エンジンからホストに渡される CompilerErrorCollection。
解説
テキスト テンプレートの処理が完了し、ホストに発生したエラーを渡すと、エンジンはこのメソッドを呼び出します。ホストは、それらの表示方法を決めることができます。たとえば、ホストは、エラーをユーザー インターフェイスに表示したり、エラーをファイルに書き込んだりできます
例
このメソッドは、テキスト テンプレートから呼び出すことができます。hostspecific="true" を設定する必要があります。
<#@ template hostspecific="true" language="C#" #>
<#@ output extension=".txt" #>
<#@ import namespace="System.CodeDom.Compiler" #>
<#
string message = "test message";
this.Host.LogErrors(new CompilerErrorCollection()
{ new CompilerError(
this.Host.TemplateFile, // Identify the source of the error.
0, 0, "0", // Line, column, error ID.
message) }); // Message displayed in error window.
#>
カスタム ホストを実装するコード例を次に示します。この例では、エラーはプロパティに格納されます。このカスタム ホストをインスタンス化するプログラムは、プロパティにアクセスし、エラーを Console に書き込みます。ここに示すコード例は、より長い例の一部です。コード例全体については、「チュートリアル: カスタム テキスト テンプレート ホストの作成」を参照してください。
private CompilerErrorCollection errorsValue;
public void LogErrors(CompilerErrorCollection errors)
{
errorsValue = errors;
}
Private errorsValue As CompilerErrorCollection
Public Sub LogErrors(ByVal errors As System.CodeDom.Compiler.CompilerErrorCollection) Implements Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost.LogErrors
errorsValue = errors
End Sub
次のコード例は、カスタム ホストの別の可能な実装を示しています。この例では、エラーはすぐに Console に書き込まれます。
public void LogErrors(CompilerErrorCollection errors)
{
foreach (CompilerError error in errors)
{
Console.WriteLine(error.ToString());
}
}
Public Sub LogErrors(ByVal errors As System.CodeDom.Compiler.CompilerErrorCollection) Implements Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost.LogErrors
Dim e As CompilerError
For Each e In errors
Console.WriteLine(e.ToString())
Next
End Sub
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。
参照
関連項目
ITextTemplatingEngineHost インターフェイス
Microsoft.VisualStudio.TextTemplating 名前空間