ITaskItem インターフェイス

定義

タスクで消費や生成ができる MSBuild アイテムを定義します。Defines an MSBuild item that can be consumed and emitted by tasks.

public interface class ITaskItem
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("8661674F-2148-4F71-A92A-49875511C528")]
public interface ITaskItem
type ITaskItem = interface
Public Interface ITaskItem
派生
属性

次の例は、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;
        }
    }
}

注釈

ビルド中にITaskItem作成されるオブジェクトの数は、次の理由により、プロジェクトファイルで宣言された項目と正確に対応しない場合があります。The number of ITaskItem objects created during a build may not correspond exactly to items declared in a project file for the following reasons:

  • タスクは、プロジェクトファイルで宣言されていない項目を作成することがあります。Tasks sometimes create items that were not declared in the project file.

  • 項目コレクションは、ワイルドカードを使用してプロジェクトファイルで宣言できます。これにより、ビルド時に多くの項目が作成される可能性があります。An item collection can be declared in the project file with wildcards, which could create many items when built.

プロパティ

ItemSpec

項目の指定を取得または設定します。Gets or sets the item specification.

MetadataCount

アイテムに関連付けられているメタデータ エントリの数を取得します。Gets the number of metadata entries associated with the item.

MetadataNames

アイテムに関連付けられているメタデータ エントリの名前を取得します。Gets the names of the metadata entries associated with the item.

メソッド

CloneCustomMetadata()

カスタム メタデータのコレクションを取得します。Gets the collection of custom metadata.

CopyMetadataTo(ITaskItem)

カスタム メタデータ エントリを別のアイテムにコピーします。Copies the custom metadata entries to another item.

GetMetadata(String)

指定したメタデータ エントリの値を取得します。Gets the value of the specified metadata entry.

RemoveMetadata(String)

指定したメタデータ エントリをアイテムから削除します。Removes the specified metadata entry from the item.

SetMetadata(String, String)

アイテムのカスタム メタデータ エントリを追加または変更します。Adds or changes a custom metadata entry to the item.

適用対象