ITaskItem

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

ITaskItem インターフェイス

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

タスクで消費や生成ができる MSBuild アイテムを定義します。

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

Visual Basic (宣言)

<GuidAttribute("8661674F-2148-4F71-A92A-49875511C528")>
 _
<ComVisibleAttribute(True)> _
Public Interface ITaskItem

Visual Basic (使用法)

Dim instance As ITaskItem

C#

[GuidAttribute("8661674F-2148-4F71-A92A-49875511C528")] 
[ComVisibleAttribute(true)] 
public interface ITaskItem

C++

[GuidAttribute(L"8661674F-2148-4F71-A92A-49875511C528")] 
[ComVisibleAttribute(true)] 
public interface class ITaskItem

J#

/** @attribute GuidAttribute("8661674F-2148-4F71-A92A-49875511C528") */
 
/** @attribute ComVisibleAttribute(true) */ 
public interface ITaskItem

JScript

GuidAttribute("8661674F-2148-4F71-A92A-49875511C528") 
ComVisibleAttribute(true) 
public interface ITaskItem

解説

ビルド中に作成される ITaskItem オブジェクトの多くは、プロジェクト ファイルで宣言されているアイテムと厳密には対応していません。これには次の理由があります。

• タスクによって、プロジェクト ファイルで宣言されていないアイテムが作成されることがある。

• プロジェクト ファイルでワイルドカードを使用してアイテム コレクションを宣言した場合、ビルド時に多数のアイテムが作成されることがある。

使用例

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

プラットフォーム

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

参照

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

ITaskItem プロパティ

パブリック プロパティ

	名前	説明
	ItemSpec	アイテムの指定を取得または設定します。
	MetadataCount	アイテムに関連付けられているメタデータ エントリの数を取得します。
	MetadataNames	アイテムに関連付けられているメタデータ エントリの名前を取得します。

参照

関連項目

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

ITaskItem メソッド

パブリック メソッド

	名前	説明
	CloneCustomMetadata	カスタム メタデータのコレクションを取得します。
	CopyMetadataTo	カスタム メタデータ エントリを別のアイテムにコピーします。
	GetMetadata	指定したメタデータ エントリの値を取得します。
	RemoveMetadata	指定したメタデータ エントリをアイテムから削除します。
	SetMetadata	アイテムのカスタム メタデータ エントリを追加または変更します。

参照

関連項目

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

ITaskItem メンバ

タスクで消費や生成ができる MSBuild アイテムを定義します。

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

パブリック プロパティ

	名前	説明
	ItemSpec	アイテムの指定を取得または設定します。
	MetadataCount	アイテムに関連付けられているメタデータ エントリの数を取得します。
	MetadataNames	アイテムに関連付けられているメタデータ エントリの名前を取得します。

パブリック メソッド

	名前	説明
	CloneCustomMetadata	カスタム メタデータのコレクションを取得します。
	CopyMetadataTo	カスタム メタデータ エントリを別のアイテムにコピーします。
	GetMetadata	指定したメタデータ エントリの値を取得します。
	RemoveMetadata	指定したメタデータ エントリをアイテムから削除します。
	SetMetadata	アイテムのカスタム メタデータ エントリを追加または変更します。

参照

関連項目

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