TaskLoggingHelper

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

TaskLoggingHelper クラス

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

タスクで使用するヘルパー ログ メソッドを提供します。

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

Visual Basic (宣言)

Public Class TaskLoggingHelper
    Inherits MarshalByRefObject

Visual Basic (使用法)

Dim instance As TaskLoggingHelper

C#

public class TaskLoggingHelper : MarshalByRefObject

C++

public ref class TaskLoggingHelper : public
 MarshalByRefObject

J#

public class TaskLoggingHelper extends MarshalByRefObject

JScript

public class TaskLoggingHelper extends
 MarshalByRefObject

使用例

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
   System.MarshalByRefObject
    Microsoft.Build.Utilities.TaskLoggingHelper
       Microsoft.Build.Tasks.TaskLoggingHelperExtension

スレッド セーフ

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

参照

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

TaskLoggingHelper コンストラクタ

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

TaskLoggingHelper クラスの新しいインスタンスを初期化し、それを指定したタスク インスタンスに関連付けます。

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

Visual Basic (宣言)

Public Sub New ( _
    taskInstance As ITask _
)

Visual Basic (使用法)

Dim taskInstance As ITask

Dim instance As New TaskLoggingHelper(taskInstance)

C#

public TaskLoggingHelper (
    ITask taskInstance
)

C++

public:
TaskLoggingHelper (
    ITask^ taskInstance
)

J#

public TaskLoggingHelper (
    ITask taskInstance
)

JScript

public function TaskLoggingHelper (
    taskInstance : ITask
)

パラメータ

taskInstance

このタスクのインスタンスを格納しているタスク。

.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

参照

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

TaskLoggingHelper プロパティ

パブリック プロパティ

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

	名前	説明
	HasLoggedErrors	タスクがこのログ ヘルパー オブジェクトを介してエラーを記録したかどうかを示す値を取得します。
	HelpKeywordPrefix	リソース名からヘルプ キーワードを作成するために使用するプレフィックスを取得または設定します。
	TaskResources	ログ メソッドで使用されるカルチャ固有のリソースを取得または設定します。

プロテクト プロパティ

	名前	説明
	BuildEngine	タスクに関連付けられているビルド エンジンを取得します。
	TaskName	親タスクの名前を取得します。

参照

関連項目

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

TaskLoggingHelper メソッド

パブリック メソッド

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

	名前	説明
	CreateObjRef	リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 ( MarshalByRefObject から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	ExtractMessageCode	指定した完全なメッセージ文字列からメッセージ コード プレフィックスを抽出します。
	FormatResourceString	指定したリソース文字列を読み込み、オプションとして、指定した引数を使用して文字列を書式指定します。
	FormatString	指定した引数を使用して指定した文字列を書式指定します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	LogCommandLine	オーバーロードされます。 コマンド ラインを記録します。
	LogError	オーバーロードされます。 エラーを記録します。
	LogErrorFromException	オーバーロードされます。 指定した例外からのメッセージを使用してエラーを記録します。
	LogErrorFromResources	オーバーロードされます。 指定したリソース文字列を使用してエラーを記録します。
	LogErrorWithCodeFromResources	オーバーロードされます。 指定したリソース文字列を使用して、エラーとエラー コードを記録します。
	LogExternalProjectFinished	カスタムの ExternalProjectFinishedEventArgs ビルド イベントを記録する場合に使用します。
	LogExternalProjectStarted	カスタムの ExternalProjectStartedEventArgs ビルド イベントを記録する場合に使用します。
	LogMessage	オーバーロードされます。 指定した文字列を使用してメッセージを記録します。
	LogMessageFromResources	オーバーロードされます。 指定したリソース文字列を使用してメッセージを記録します。
	LogMessageFromText	指定したテキスト行からのエラー メッセージまたは警告を記録します。
	LogMessagesFromFile	オーバーロードされます。 指定したファイル内のそれぞれのテキスト行に対して、エラー、警告、およびメッセージを記録します。
	LogMessagesFromStream	指定したストリームからのエラー メッセージまたは警告を記録します。
	LogWarning	オーバーロードされます。 警告を記録します。
	LogWarningFromException	オーバーロードされます。 指定した例外からのメッセージを使用して警告を記録します。
	LogWarningFromResources	オーバーロードされます。 指定したリソース文字列を使用して警告を記録します。
	LogWarningWithCodeFromResources	オーバーロードされます。 指定したリソース文字列を使用して、警告と警告コードを記録します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

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

参照

関連項目

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

TaskLoggingHelper メンバ

タスクで使用するヘルパー ログ メソッドを提供します。

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

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

	名前	説明
	TaskLoggingHelper	TaskLoggingHelper クラスの新しいインスタンスを初期化し、それを指定したタスク インスタンスに関連付けます。

パブリック プロパティ

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

	名前	説明
	HasLoggedErrors	タスクがこのログ ヘルパー オブジェクトを介してエラーを記録したかどうかを示す値を取得します。
	HelpKeywordPrefix	リソース名からヘルプ キーワードを作成するために使用するプレフィックスを取得または設定します。
	TaskResources	ログ メソッドで使用されるカルチャ固有のリソースを取得または設定します。

プロテクト プロパティ

	名前	説明
	BuildEngine	タスクに関連付けられているビルド エンジンを取得します。
	TaskName	親タスクの名前を取得します。

パブリック メソッド

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

	名前	説明
	CreateObjRef	リモート オブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (MarshalByRefObject から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	ExtractMessageCode	指定した完全なメッセージ文字列からメッセージ コード プレフィックスを抽出します。
	FormatResourceString	指定したリソース文字列を読み込み、オプションとして、指定した引数を使用して文字列を書式指定します。
	FormatString	指定した引数を使用して指定した文字列を書式指定します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービス オブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	LogCommandLine	オーバーロードされます。 コマンド ラインを記録します。
	LogError	オーバーロードされます。 エラーを記録します。
	LogErrorFromException	オーバーロードされます。 指定した例外からのメッセージを使用してエラーを記録します。
	LogErrorFromResources	オーバーロードされます。 指定したリソース文字列を使用してエラーを記録します。
	LogErrorWithCodeFromResources	オーバーロードされます。 指定したリソース文字列を使用して、エラーとエラー コードを記録します。
	LogExternalProjectFinished	カスタムの ExternalProjectFinishedEventArgs ビルド イベントを記録する場合に使用します。
	LogExternalProjectStarted	カスタムの ExternalProjectStartedEventArgs ビルド イベントを記録する場合に使用します。
	LogMessage	オーバーロードされます。 指定した文字列を使用してメッセージを記録します。
	LogMessageFromResources	オーバーロードされます。 指定したリソース文字列を使用してメッセージを記録します。
	LogMessageFromText	指定したテキスト行からのエラー メッセージまたは警告を記録します。
	LogMessagesFromFile	オーバーロードされます。 指定したファイル内のそれぞれのテキスト行に対して、エラー、警告、およびメッセージを記録します。
	LogMessagesFromStream	指定したストリームからのエラー メッセージまたは警告を記録します。
	LogWarning	オーバーロードされます。 警告を記録します。
	LogWarningFromException	オーバーロードされます。 指定した例外からのメッセージを使用して警告を記録します。
	LogWarningFromResources	オーバーロードされます。 指定したリソース文字列を使用して警告を記録します。
	LogWarningWithCodeFromResources	オーバーロードされます。 指定したリソース文字列を使用して、警告と警告コードを記録します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

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

参照

関連項目

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