Task

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

Task クラス

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

派生フォームでオーバーライドされると、タスクに機能を提供します。

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

Visual Basic (宣言)

Public MustInherit Class
 Task
    Implements ITask

Visual Basic (使用法)

Dim instance As Task

C#

public abstract class Task : ITask

C++

public ref class Task abstract : ITask

J#

public abstract class Task implements ITask

JScript

public abstract class Task implements ITask

解説

この抽象クラスは、ITask インターフェイスのメソッドおよびプロパティに既定の実装を提供します。

このクラスは、派生フォーム内でのみインスタンス化できます。

使用例

1 つ以上のディレクトリを作成するタスクのコード例を次に示します。

C#

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

継承階層

System.Object
  Microsoft.Build.Utilities.Task
     Microsoft.Build.Tasks.GenerateManifestBase
     Microsoft.Build.Tasks.SignFile
     Microsoft.Build.Tasks.TaskExtension
     Microsoft.Build.Tasks.UpdateManifest
     Microsoft.Build.Utilities.ToolTask

スレッド セーフ

この型の 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

参照

関連項目
Task メンバ
Microsoft.Build.Utilities 名前空間

Task コンストラクタ ()

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

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

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

Visual Basic (宣言)

Protected Sub New

Visual Basic (使用法)

Dim instance As New Task

C#

protected Task ()

C++

protected:
Task ()

J#

protected Task ()

JScript

protected function Task ()

.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

参照

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

Task コンストラクタ

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

名前	説明
Task ()	Task クラスの新しいインスタンスを初期化します。
Task (ResourceManager)	TaskResources を指定して、Task クラスの新しいインスタンスを初期化します。
Task (ResourceManager, String)	指定した TaskResources と HelpKeywordPrefix を使用して、Task クラスの新しいインスタンスを初期化します。

参照

関連項目

Task クラス
Task メンバ
Microsoft.Build.Utilities 名前空間

Task コンストラクタ (ResourceManager)

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

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

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

Visual Basic (宣言)

Protected Sub New ( _
    taskResources As ResourceManager _
)

Visual Basic (使用法)

Dim taskResources As ResourceManager

Dim instance As New Task(taskResources)

C#

protected Task (
    ResourceManager taskResources
)

C++

protected:
Task (
    ResourceManager^ taskResources
)

J#

protected Task (
    ResourceManager taskResources
)

JScript

protected function Task (
    taskResources : ResourceManager
)

パラメータ

taskResources

タスク リソース。

解説

このコンストラクタは、派生タスク クラスがリソースを登録できるようにします。

.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

参照

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

Task コンストラクタ (ResourceManager, String)

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

指定した TaskResources と HelpKeywordPrefix を使用して、Task クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Protected Sub New ( _
    taskResources As ResourceManager, _
    helpKeywordPrefix As String _
)

Visual Basic (使用法)

Dim taskResources As ResourceManager
Dim helpKeywordPrefix As String

Dim instance As New Task(taskResources,
 helpKeywordPrefix)

C#

protected Task (
    ResourceManager taskResources,
    string helpKeywordPrefix
)

C++

protected:
Task (
    ResourceManager^ taskResources, 
    String^ helpKeywordPrefix
)

J#

protected Task (
    ResourceManager taskResources, 
    String helpKeywordPrefix
)

JScript

protected function Task (
    taskResources : ResourceManager, 
    helpKeywordPrefix : String
)

パラメータ

taskResources

タスク リソース。

helpKeywordPrefix

ヘルプ キーワードを作成するために文字列リソースに追加するプレフィックス。

解説

このコンストラクタは、派生タスク クラスがリソースを登録できるようにし、文字列リソース名からヘルプ キーワードを作成するためのプレフィックスを提供します。helpKeywordPrefix が空の文字列の場合は、文字列リソース名がそのままヘルプ キーワードとして使用されます。

.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

参照

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

Task プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	BuildEngine	タスクによって使用される IBuildEngine オブジェクトのインスタンスを取得または設定します。
	HostObject	タスクに関連付けられているホスト オブジェクトを取得または設定します。
	Log	タスク ログ メソッドを格納している TaskLoggingHelper クラスのインスタンスを取得します。

プロテクト プロパティ

	名前	説明
	HelpKeywordPrefix	リソース名からヘルプ キーワードを作成するために使用するプレフィックスを取得または設定します。
	TaskResources	タスクに関連付けられているカルチャ固有のリソースを取得または設定します。

参照

関連項目

Task クラス
Microsoft.Build.Utilities 名前空間

Task メソッド

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	Execute	派生クラスでオーバーライドされると、タスクを実行します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

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

参照

関連項目

Task クラス
Microsoft.Build.Utilities 名前空間

Task メンバ

派生フォームでオーバーライドされると、タスクに機能を提供します。

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

プロテクト コンストラクタ

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

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	BuildEngine	タスクによって使用される IBuildEngine オブジェクトのインスタンスを取得または設定します。
	HostObject	タスクに関連付けられているホスト オブジェクトを取得または設定します。
	Log	タスク ログ メソッドを格納している TaskLoggingHelper クラスのインスタンスを取得します。

プロテクト プロパティ

	名前	説明
	HelpKeywordPrefix	リソース名からヘルプ キーワードを作成するために使用するプレフィックスを取得または設定します。
	TaskResources	タスクに関連付けられているカルチャ固有のリソースを取得または設定します。

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	Execute	派生クラスでオーバーライドされると、タスクを実行します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

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

参照

関連項目

Task クラス
Microsoft.Build.Utilities 名前空間