Engine

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

Engine クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

MSBuild エンジンを表します。

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

Visual Basic (宣言)

Public Class Engine

Visual Basic (使用法)

Dim instance As Engine

C#

public class Engine

C++

public ref class Engine

J#

public class Engine

JScript

public class Engine

解説

プロジェクト対プロジェクトの依存関係を持つシステムにおいて、Engine はプロジェクトのビルドを維持できます。これにより、特定のビルドにおいて同じプロジェクト内の同じターゲットを何回もビルドし直さずに済みます。

使用例

Engine オブジェクトを作成し、BuildProjectFile メソッドを使用してプロジェクト ファイルをビルドする例を次に示します。情報をファイルに記録するために、FileLogger クラスが使用されています。

Visual Basic

Module Module1
    'You need to add references to Microsoft.Build.Framework and
    'Microsoft.Build.BuildEngine
    Sub Main()
        'Create a new Engine object
        Dim engine As New
 Engine()

        'Point to the correct path that contains the 2.0 clr/tools
        engine.BinPath = "c:\windows\microsoft.net\framework\v2.0.xxxxx"

        'Instantiate a new FileLogger to generate a build log
        Dim logger As New
 FileLogger()

        'Set logfile parameter to indicate the log destination
        logger.Parameters = "logfile=c:\temp\build.log"

        'Register the logger with the engine
        engine.RegisterLogger(logger)

        'Build the project file
        Dim success As Boolean
 = engine.BuildProjectFile("c:\temp\validate.proj")

        If success Then
            Console.WriteLine("Build successful")
        Else
            Console.WriteLine("Build failed - view the log")
        End If
    End Sub

End Module

C#

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Build.BuildEngine;

namespace BuildAProjectCS
{
    class Program
    {       
        static void Main(string[]
 args)
        {
            // Instantiate a new Engine object
            Engine engine = new Engine();

            // Point to the correct path that contains the 2.0 clr/tools
            engine.BinPath = @"c:\windows\microsoft.net\framework\v2.0.xxxxx";

            // Instantiate a new FileLogger to generate build log
            FileLogger logger = new FileLogger();

            // Set logfile parameter to indicate the log destination
            logger.Parameters = @"logfile=C:\temp\build.log";

            // Register the logger with the engine
            engine.RegisterLogger(logger);

            // Build a project file
            bool success = engine.BuildProjectFile(@"c:\temp\validate.proj");

            if (success)
                Console.WriteLine("Success!");
            else
                Console.WriteLine("Build failed - look at c:\temp\build.log
 for details");
        }
    }
}

継承階層

System.Object
  Microsoft.Build.BuildEngine.Engine

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

関連項目
Engine メンバ
Microsoft.Build.BuildEngine 名前空間

Engine コンストラクタ ()

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

Engine クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New Engine

C#

public Engine ()

C++

public:
Engine ()

J#

public Engine ()

JScript

public function Engine ()

使用例

Engine オブジェクトを作成し、BuildProjectFile メソッドを使用してプロジェクト ファイルをビルドする例を次に示します。情報をファイルに記録するために、FileLogger クラスが使用されています。

Visual Basic

Module Module1
    'You need to add references to Microsoft.Build.Framework and
    'Microsoft.Build.BuildEngine
    Sub Main()
        'Create a new Engine object
        Dim engine As New
 Engine()

        'Point to the correct path that contains the 2.0 clr/tools
        engine.BinPath = "c:\windows\microsoft.net\framework\v2.0.xxxxx"

        'Instantiate a new FileLogger to generate a build log
        Dim logger As New
 FileLogger()

        'Set logfile parameter to indicate the log destination
        logger.Parameters = "logfile=c:\temp\build.log"

        'Register the logger with the engine
        engine.RegisterLogger(logger)

        'Build the project file
        Dim success As Boolean
 = engine.BuildProjectFile("c:\temp\validate.proj")

        If success Then
            Console.WriteLine("Build successful")
        Else
            Console.WriteLine("Build failed - view the log")
        End If
    End Sub

End Module

C#

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Build.BuildEngine;

namespace BuildAProjectCS
{
    class Program
    {       
        static void Main(string[]
 args)
        {
            // Instantiate a new Engine object
            Engine engine = new Engine();

            // Point to the correct path that contains the 2.0 clr/tools
            engine.BinPath = @"c:\windows\microsoft.net\framework\v2.0.xxxxx";

            // Instantiate a new FileLogger to generate build log
            FileLogger logger = new FileLogger();

            // Set logfile parameter to indicate the log destination
            logger.Parameters = @"logfile=C:\temp\build.log";

            // Register the logger with the engine
            engine.RegisterLogger(logger);

            // Build a project file
            bool success = engine.BuildProjectFile(@"c:\temp\validate.proj");

            if (success)
                Console.WriteLine("Success!");
            else
                Console.WriteLine("Build failed - look at c:\temp\build.log
 for details");
        }
    }
}

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

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
Engine クラス
Engine メンバ
Microsoft.Build.BuildEngine 名前空間

Engine コンストラクタ

Engine クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
Engine ()	Engine クラスの新しいインスタンスを初期化します。
Engine (String)	BinPath を指定して、Engine クラスの新しいインスタンスを初期化します。

参照

関連項目

Engine クラス
Engine メンバ
Microsoft.Build.BuildEngine 名前空間

Engine コンストラクタ (String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

BinPath を指定して、Engine クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    binPath As String _
)

Visual Basic (使用法)

Dim binPath As String

Dim instance As New Engine(binPath)

C#

public Engine (
    string binPath
)

C++

public:
Engine (
    String^ binPath
)

J#

public Engine (
    String binPath
)

JScript

public function Engine (
    binPath : String
)

パラメータ

binPath

MSBuild.exe へのパス。

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

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
Engine クラス
Engine メンバ
Microsoft.Build.BuildEngine 名前空間

Engine プロパティ

パブリック プロパティ

	名前	説明
	GlobalEngine	この AppDomain に対してグローバルな (共有される) Engine を取得します。
	Version	Engine のバージョンを取得します。

参照

関連項目

Engine クラス
Microsoft.Build.BuildEngine 名前空間

Engine メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	BuildProject	オーバーロードされます。 指定したプロジェクトをビルドします。
	BuildProjectFile	オーバーロードされます。 指定したプロジェクト ファイルを読み込み、プロジェクトをビルドします。
	CreateNewProject	この Engine に関連付けられる空の Project オブジェクトを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetLoadedProject	指定したプロジェクト ファイルに関連付けられている Project オブジェクトを返します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	RegisterLogger	指定した logger を Engine に登録します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)
	UnloadAllProjects	Engine から Project オブジェクトへのすべての参照を削除します。
	UnloadProject	指定した Project への参照をEngine から削除します。
	UnregisterAllLoggers	Engine からすべての logger を登録解除します。

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

Engine クラス
Microsoft.Build.BuildEngine 名前空間

Engine メンバ

MSBuild エンジンを表します。

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

パブリック コンストラクタ

	名前	説明
	Engine	オーバーロードされます。 Engine クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	GlobalEngine	この AppDomain に対してグローバルな (共有される) Engine を取得します。
	Version	Engine のバージョンを取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	BuildProject	オーバーロードされます。 指定したプロジェクトをビルドします。
	BuildProjectFile	オーバーロードされます。 指定したプロジェクト ファイルを読み込み、プロジェクトをビルドします。
	CreateNewProject	この Engine に関連付けられる空の Project オブジェクトを作成します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetLoadedProject	指定したプロジェクト ファイルに関連付けられている Project オブジェクトを返します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	RegisterLogger	指定した logger を Engine に登録します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)
	UnloadAllProjects	Engine から Project オブジェクトへのすべての参照を削除します。
	UnloadProject	指定した Project への参照をEngine から削除します。
	UnregisterAllLoggers	Engine からすべての logger を登録解除します。

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

Engine クラス
Microsoft.Build.BuildEngine 名前空間