BuildErrorEventArgs クラス
アセンブリ: Microsoft.Build.Framework (microsoft.build.framework.dll 内)
構文
ビルド イベントに応答する基本 logger を作成する方法を次の例に示します。
using System; using System.IO; using System.Security; using Microsoft.Build.Framework; using Microsoft.Build.Utilities; namespace MyLoggers { // This logger will derive from the Microsoft.Build.Utilities.Logger class, // which provides it with getters and setters for Verbosity and Parameters, // and a default empty Shutdown() implementation. public class BasicFileLogger : Logger { /// <summary> /// Initialize is guaranteed to be called by MSBuild at the start of the build /// before any events are raised. /// </summary> public override void Initialize(IEventSource eventSource) { // The name of the log file should be passed as the first item in the // "parameters" specification in the /logger switch. It is required // to pass a log file to this logger. Other loggers may have zero or more than // one parameters. if (null == Parameters) { throw new LoggerException("Log file was not set."); } string[] parameters = Parameters.Split(';'); string logFile = parameters[0]; if (String.IsNullOrEmpty(logFile)) { throw new LoggerException("Log file was not set."); } if (parameters.Length > 1) { throw new LoggerException("Too many parameters passed."); } try { // Open the file this.streamWriter = new StreamWriter(logFile); } catch (Exception ex) { if ( ex is UnauthorizedAccessException || ex is ArgumentNullException || ex is PathTooLongException || ex is DirectoryNotFoundException || ex is NotSupportedException || ex is ArgumentException || ex is SecurityException || ex is IOException ) { throw new LoggerException("Failed to create log file: " + ex.Message); } else { // Unexpected failure throw; } } // For brevity, we'll only register for certain event types. Loggers can also // register to handle TargetStarted/Finished and other events. eventSource.ProjectStarted += new ProjectStartedEventHandler(eventSource_ProjectStarted); eventSource.TaskStarted += new TaskStartedEventHandler(eventSource_TaskStarted); eventSource.MessageRaised += new BuildMessageEventHandler(eventSource_MessageRaised); eventSource.WarningRaised += new BuildWarningEventHandler(eventSource_WarningRaised); eventSource.ErrorRaised += new BuildErrorEventHandler(eventSource_ErrorRaised); eventSource.ProjectFinished += new ProjectFinishedEventHandler(eventSource_ProjectFinished); } void eventSource_ErrorRaised(object sender, BuildErrorEventArgs e) { // BuildErrorEventArgs adds LineNumber, ColumnNumber, File, amongst other parameters string line = String.Format(": ERROR {0}({1},{2}): ", e.File, e.LineNumber, e.ColumnNumber); WriteLineWithSenderAndMessage(line, e); } void eventSource_WarningRaised(object sender, BuildWarningEventArgs e) { // BuildWarningEventArgs adds LineNumber, ColumnNumber, File, amongst other parameters string line = String.Format(": Warning {0}({1},{2}): ", e.File, e.LineNumber, e.ColumnNumber); WriteLineWithSenderAndMessage(line, e); } void eventSource_MessageRaised(object sender, BuildMessageEventArgs e) { // BuildMessageEventArgs adds Importance to BuildEventArgs // Let's take account of the verbosity setting we've been passed in deciding whether to log the message if ((e.Importance == MessageImportance.High && IsVerbosityAtLeast(LoggerVerbosity.Minimal)) || (e.Importance == MessageImportance.Normal && IsVerbosityAtLeast(LoggerVerbosity.Normal)) || (e.Importance == MessageImportance.Low && IsVerbosityAtLeast(LoggerVerbosity.Detailed)) ) { WriteLineWithSenderAndMessage(String.Empty, e); } } void eventSource_TaskStarted(object sender, TaskStartedEventArgs e) { // TaskStartedEventArgs adds ProjectFile, TaskFile, TaskName // To keep this log clean, this logger will ignore these events. } void eventSource_ProjectStarted(object sender, ProjectStartedEventArgs e) { // ProjectStartedEventArgs adds ProjectFile, TargetNames // Just the regular message string is good enough here, so just display that. WriteLine(String.Empty, e); indent++; } void eventSource_ProjectFinished(object sender, ProjectFinishedEventArgs e) { // The regular message string is good enough here too. indent--; WriteLine(String.Empty, e); } /// <summary> /// Write a line to the log, adding the SenderName and Message /// (these parameters are on all MSBuild event argument objects) /// </summary> private void WriteLineWithSenderAndMessage(string line, BuildEventArgs e) { if (0 == String.Compare(e.SenderName, "MSBuild", true /*ignore case*/)) { // Well, if the sender name is MSBuild, let's leave it out for prettiness WriteLine(line, e); } else { WriteLine(e.SenderName + ": " + line, e); } } /// <summary> /// Just write a line to the log /// </summary> private void WriteLine(string line, BuildEventArgs e) { for (int i = indent; i > 0; i--) { streamWriter.Write("\t"); } streamWriter.WriteLine(line + e.Message); } /// <summary> /// Shutdown() is guaranteed to be called by MSBuild at the end of the build, after all /// events have been raised. /// </summary> public override void Shutdown() { // Done logging, let go of the file streamWriter.Close(); } private StreamWriter streamWriter; private int indent; } }
System.EventArgs
Microsoft.Build.Framework.BuildEventArgs
Microsoft.Build.Framework.BuildErrorEventArgs
プラットフォーム
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
参照
BuildErrorEventArgs コンストラクタ ()
アセンブリ: Microsoft.Build.Framework (microsoft.build.framework.dll 内)
構文
.NET Framework のセキュリティ
プラットフォーム
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
参照
BuildErrorEventArgs コンストラクタ
オーバーロードの一覧
名前 | 説明 |
---|---|
BuildErrorEventArgs () | BuildErrorEventArgs クラスの新しいインスタンスを初期化します。 |
BuildErrorEventArgs (String, String, String, Int32, Int32, Int32, Int32, String, String, String) | SubCategory、Code、File、LineNumber、ColumnNumber、EndLineNumber、EndColumnNumber、Message、HelpKeyword、SenderName のそれぞれの値を指定して、BuildErrorEventArgs クラスの新しいインスタンスを初期化します。 |
BuildErrorEventArgs コンストラクタ (String, String, String, Int32, Int32, Int32, Int32, String, String, String)
アセンブリ: Microsoft.Build.Framework (microsoft.build.framework.dll 内)
構文
Public Sub New ( _ subcategory As String, _ code As String, _ file As String, _ lineNumber As Integer, _ columnNumber As Integer, _ endLineNumber As Integer, _ endColumnNumber As Integer, _ message As String, _ helpKeyword As String, _ senderName As String _ )
Dim subcategory As String Dim code As String Dim file As String Dim lineNumber As Integer Dim columnNumber As Integer Dim endLineNumber As Integer Dim endColumnNumber As Integer Dim message As String Dim helpKeyword As String Dim senderName As String Dim instance As New BuildErrorEventArgs(subcategory, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName)
public BuildErrorEventArgs ( string subcategory, string code, string file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, string message, string helpKeyword, string senderName )
public: BuildErrorEventArgs ( String^ subcategory, String^ code, String^ file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, String^ message, String^ helpKeyword, String^ senderName )
public BuildErrorEventArgs ( String subcategory, String code, String file, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, String message, String helpKeyword, String senderName )
public function BuildErrorEventArgs ( subcategory : String, code : String, file : String, lineNumber : int, columnNumber : int, endLineNumber : int, endColumnNumber : int, message : String, helpKeyword : String, senderName : String )
プラットフォーム
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
参照
BuildErrorEventArgs プロパティ
パブリック プロパティ
名前 | 説明 | |
---|---|---|
Code | イベントのエラー コードを取得します。 | |
ColumnNumber | イベントの発生元となったコード セクションの先頭に対応する列番号を取得します。 | |
EndColumnNumber | イベントの発生元となったコード セクションの末尾に対応する列番号を取得します。 | |
EndLineNumber | イベントの発生元となったコード セクションの末尾に対応する行番号を取得します。 | |
File | イベントの発生元のファイル名を取得します。 | |
HelpKeyword | イベントのヘルプ キーワードを取得します。 ( BuildEventArgs から継承されます。) | |
LineNumber | イベントの発生元となったコード セクションの先頭に対応する行番号を取得します。 | |
Message | イベントに関するメッセージを取得します。 ( BuildEventArgs から継承されます。) | |
SenderName | イベントの発生元の Object の名前を取得します。 ( BuildEventArgs から継承されます。) | |
Subcategory | イベントのカスタム サブタイプを取得します。 | |
ThreadId | イベントの発生元のスレッドを示す、整数の識別子を取得します。 ( BuildEventArgs から継承されます。) | |
Timestamp | イベントが発生した時刻を DateTime として取得します。 ( BuildEventArgs から継承されます。) |
BuildErrorEventArgs メソッド
パブリック メソッド
名前 | 説明 | |
---|---|---|
Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。) | |
GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。) | |
GetType | 現在のインスタンスの Type を取得します。 ( Object から継承されます。) | |
ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。) | |
ToString | 現在の Object を表す String を返します。 ( Object から継承されます。) |
名前 | 説明 | |
---|---|---|
Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。) | |
MemberwiseClone | 現在の Object の簡易コピーを作成します。 ( Object から継承されます。) |
BuildErrorEventArgs メンバ
BuildErrorEventArgs データ型で公開されるメンバを以下の表に示します。
パブリック コンストラクタ
名前 | 説明 | |
---|---|---|
BuildErrorEventArgs | オーバーロードされます。 BuildErrorEventArgs クラスの新しいインスタンスを初期化します。 |
パブリック プロパティ
名前 | 説明 | |
---|---|---|
Code | イベントのエラー コードを取得します。 | |
ColumnNumber | イベントの発生元となったコード セクションの先頭に対応する列番号を取得します。 | |
EndColumnNumber | イベントの発生元となったコード セクションの末尾に対応する列番号を取得します。 | |
EndLineNumber | イベントの発生元となったコード セクションの末尾に対応する行番号を取得します。 | |
File | イベントの発生元のファイル名を取得します。 | |
HelpKeyword | イベントのヘルプ キーワードを取得します。(BuildEventArgs から継承されます。) | |
LineNumber | イベントの発生元となったコード セクションの先頭に対応する行番号を取得します。 | |
Message | イベントに関するメッセージを取得します。(BuildEventArgs から継承されます。) | |
SenderName | イベントの発生元の Object の名前を取得します。(BuildEventArgs から継承されます。) | |
Subcategory | イベントのカスタム サブタイプを取得します。 | |
ThreadId | イベントの発生元のスレッドを示す、整数の識別子を取得します。(BuildEventArgs から継承されます。) | |
Timestamp | イベントが発生した時刻を DateTime として取得します。(BuildEventArgs から継承されます。) |
名前 | 説明 | |
---|---|---|
Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。) | |
GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。) | |
GetType | 現在のインスタンスの Type を取得します。 (Object から継承されます。) | |
ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。) | |
ToString | 現在の Object を表す String を返します。 (Object から継承されます。) |
名前 | 説明 | |
---|---|---|
Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。) | |
MemberwiseClone | 現在の Object の簡易コピーを作成します。 (Object から継承されます。) |
- BuildErrorEventArgsのページへのリンク