IEventSource

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

IEventSource イベント

パブリック イベント

	名前	説明
	AnyEventRaised	ビルドによって他の種類のビルド イベントが発生したときに、発生します。
	BuildFinished	ビルドが終了したときに発生します。
	BuildStarted	ビルドが開始したときに発生します。
	CustomEventRaised	ビルドによってカスタム イベントが発生したときに、発生します。
	ErrorRaised	ビルドによってエラーが発生したときに、発生します。
	MessageRaised	ビルドによってメッセージが発生したときに、発生します。
	ProjectFinished	プロジェクトでビルドが終了したときに発生します。
	ProjectStarted	プロジェクトでビルドが開始したときに発生します。
	StatusEventRaised	ビルドによってステータス イベントが発生したときに、発生します。
	TargetFinished	対象でビルドが終了したときに発生します。
	TargetStarted	対象でビルドが開始したときに発生します。
	TaskFinished	タスクの実行が完了したときに発生します。
	TaskStarted	タスクの実行が開始したときに発生します。
	WarningRaised	ビルドによって警告が発生したときに、発生します。

参照

関連項目

IEventSource インターフェイス
Microsoft.Build.Framework 名前空間

IEventSource インターフェイス

メモ : このインターフェイスは、.NET Framework version 2.0 で新しく追加されたものです。

ビルド エンジンによって発生するイベントを定義します。Logger は Initialize メソッドでこのインターフェイスを実装するオブジェクトを受け取り、それを使用して、受け取る対象のイベントにサブスクライブします。

名前空間: Microsoft.Build.Framework
アセンブリ: Microsoft.Build.Framework (microsoft.build.framework.dll 内)
構文

Visual Basic (宣言)

Public Interface IEventSource

Visual Basic (使用法)

Dim instance As IEventSource

C#

public interface IEventSource

C++

public interface class IEventSource

J#

public interface IEventSource

JScript

public interface IEventSource

使用例

ビルド イベントに応答する基本 Logger を作成する方法を次の例に示します。

C#

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;
    }
}

プラットフォーム

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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
IEventSource メンバ
Microsoft.Build.Framework 名前空間

IEventSource メンバ

ビルド エンジンによって発生するイベントを定義します。Logger は Initialize メソッドでこのインターフェイスを実装するオブジェクトを受け取り、それを使用して、受け取る対象のイベントにサブスクライブします。

IEventSource データ型で公開されるメンバを以下の表に示します。

パブリック イベント

	名前	説明
	AnyEventRaised	ビルドによって他の種類のビルド イベントが発生したときに、発生します。
	BuildFinished	ビルドが終了したときに発生します。
	BuildStarted	ビルドが開始したときに発生します。
	CustomEventRaised	ビルドによってカスタム イベントが発生したときに、発生します。
	ErrorRaised	ビルドによってエラーが発生したときに、発生します。
	MessageRaised	ビルドによってメッセージが発生したときに、発生します。
	ProjectFinished	プロジェクトでビルドが終了したときに発生します。
	ProjectStarted	プロジェクトでビルドが開始したときに発生します。
	StatusEventRaised	ビルドによってステータス イベントが発生したときに、発生します。
	TargetFinished	対象でビルドが終了したときに発生します。
	TargetStarted	対象でビルドが開始したときに発生します。
	TaskFinished	タスクの実行が完了したときに発生します。
	TaskStarted	タスクの実行が開始したときに発生します。
	WarningRaised	ビルドによって警告が発生したときに、発生します。

参照

関連項目

IEventSource インターフェイス
Microsoft.Build.Framework 名前空間