Task Task Task Task Class

定義

派生フォームでオーバーライドされると、タスクに機能を提供します。When overridden in a derived form, provides functionality for tasks.

public ref class Task abstract : Microsoft::Build::Framework::ITask
public abstract class Task : Microsoft.Build.Framework.ITask
type Task = class
    interface ITask
Public MustInherit Class Task
Implements ITask
継承
TaskTaskTaskTask
派生
実装

次の例は、1つ以上のディレクトリを作成するタスクのコードを示しています。The following example shows the code for a task that creates one or more directories.

using System;
using System.IO;
using System.Security;
using System.Collections;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;

namespace Microsoft.Build.Tasks
{
	/*
	 * Class: MakeDir
	 *
	 * An MSBuild task that creates one or more directories.
	 *
	 */
	public class MakeDir : Task
	{
	    // The Required attribute indicates the following to MSBuild:
	    //	     - if the parameter is a scalar type, and it is not supplied, fail the build immediately
	    //	     - if the parameter is an array type, and it is not supplied, pass in an empty array
	    // In this case the parameter is an array type, so if a project fails to pass in a value for the 
            // Directories parameter, the task will get invoked, but this implementation will do nothing,
            // because the array will be empty.
		[Required]
            // Directories to create.
		public ITaskItem[] Directories
		{
			get
			{
				return directories;
			}

			set
			{
				directories = value;
			}
		}

		// The Output attribute indicates to MSBuild that the value of this property can be gathered after the
		// task has returned from Execute(), if the project has an <Output> tag under this task's element for 
		// this property.
		[Output]
		// A project may need the subset of the inputs that were actually created, so make that available here.
		public ITaskItem[] DirectoriesCreated
		{
			get
			{
				return directoriesCreated;
			}
		}

		private ITaskItem[] directories;
		private ITaskItem[] directoriesCreated;

		/// <summary>
		/// Execute is part of the Microsoft.Build.Framework.ITask interface.
		/// When it's called, any input parameters have already been set on the task's properties.
		/// It returns true or false to indicate success or failure.
		/// </summary>
		public override bool Execute()
		{
			ArrayList items = new ArrayList();
			foreach (ITaskItem directory in Directories)
			{
				// ItemSpec holds the filename or path of an Item
				if (directory.ItemSpec.Length > 0)
				{
					try
					{
						// Only log a message if we actually need to create the folder
						if (!Directory.Exists(directory.ItemSpec))
						{
							Log.LogMessage(MessageImportance.Normal, "Creating directory " + directory.ItemSpec);
							Directory.CreateDirectory(directory.ItemSpec);
						}

						// Add to the list of created directories
						items.Add(directory);
					}
					// If a directory fails to get created, log an error, but proceed with the remaining 
					// directories.
					catch (Exception ex)
					{
						if (ex is IOException
							|| ex is UnauthorizedAccessException
							|| ex is PathTooLongException
							|| ex is DirectoryNotFoundException
							|| ex is SecurityException)
						{
							Log.LogError("Error trying to create directory " + directory.ItemSpec + ". " + ex.Message);
						}
						else
						{
							throw;
						}
					}
				}
			}

			// Populate the "DirectoriesCreated" output items.
			directoriesCreated = (ITaskItem[])items.ToArray(typeof(ITaskItem));

			// Log.HasLoggedErrors is true if the task logged any errors -- even if they were logged 
			// from a task's constructor or property setter. As long as this task is written to always log an error
			// when it fails, we can reliably return HasLoggedErrors.
			return !Log.HasLoggedErrors;
		}
	}
}

注釈

この抽象クラスは、 ITaskインターフェイスのメソッドおよびプロパティの既定の実装を提供します。This abstract class provides default implementations for the methods and properties of the ITask interface.

このクラスは、派生フォームでのみインスタンス化できます。This class can only be instantiated in a derived form.

コンストラクター

Task() Task() Task() Task()

Task クラスの新しいインスタンスを初期化します。Initializes a new instance of the Task class.

Task(ResourceManager) Task(ResourceManager) Task(ResourceManager) Task(ResourceManager)

Task を指定して、TaskResources クラスの新しいインスタンスを初期化します。Initializes a new instance of the Task class with the specified TaskResources.

Task(ResourceManager, String) Task(ResourceManager, String) Task(ResourceManager, String) Task(ResourceManager, String)

指定された TaskTaskResources を使用して、HelpKeywordPrefix クラスの新しいインスタンスを初期化します。Initializes a new instance of the Task class with the specified TaskResources and HelpKeywordPrefix.

プロパティ

BuildEngine BuildEngine BuildEngine BuildEngine

タスクで使用する IBuildEngine オブジェクトのインスタンスを取得または設定します。Gets or sets the instance of the IBuildEngine object used by the task.

BuildEngine2 BuildEngine2 BuildEngine2 BuildEngine2

タスクで使用する IBuildEngine2 オブジェクトのインスタンスを取得します。Gets the instance of the IBuildEngine2 object used by the task.

BuildEngine3 BuildEngine3 BuildEngine3 BuildEngine3

タスクで使用する IBuildEngine3 オブジェクトのインスタンスを取得します。Gets the instance of the IBuildEngine3 object used by the task.

BuildEngine4 BuildEngine4 BuildEngine4 BuildEngine4

タスクで使用する IBuildEngine4 オブジェクトのインスタンスを取得します。Gets the instance of the IBuildEngine4 object used by the task.

HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix

リソース名からヘルプ キーワードを作成するために使用するプレフィックスを取得または設定します。Gets or sets the prefix used to compose Help keywords from resource names.

HostObject HostObject HostObject HostObject

このタスクに関連付けられているホスト オブジェクトを取得または設定します。Gets or sets the host object associated with the task.

Log Log Log Log

タスク ログ メソッドを格納している TaskLoggingHelper クラスのインスタンスを取得します。Gets an instance of a TaskLoggingHelper class containing task logging methods.

TaskResources TaskResources TaskResources TaskResources

タスクに関連付けられているカルチャ固有のリソースを取得または設定します。Gets or sets the culture-specific resources associated with the task.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
Execute() Execute() Execute() Execute()

派生クラスでオーバーライドされた場合は、タスクを実行します。When overridden in a derived class, executes the task.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象