Cet article a fait l’objet d’une traduction automatique. Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez également afficher le texte anglais dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte traduit.
Traduction
Anglais

ITaskItem interface

 

Date de publication : novembre 2016

Définit un MSBuild élément qui peut être consommé et émis par les tâches.

MSBuild est désormais inclus dans Visual Studio au lieu de .NET Framework. Vous pouvez utiliser MSBuild 12.0 côte à côte avec les versions précédemment déployé avec le .NET Framework.For plus d’informations, consultez Nouveautés de MSBuild 12.0.

Espace de noms:   Microsoft.Build.Framework
Assembly:  Microsoft.Build.Framework (dans Microsoft.Build.Framework.dll)

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

NomDescription
System_CAPS_pubpropertyItemSpec

Obtient ou définit la spécification de l’élément.

MSBuild est désormais inclus dans Visual Studio au lieu de .NET Framework. Vous pouvez utiliser MSBuild 12.0 côte à côte avec les versions précédemment déployé avec le .NET Framework.For plus d’informations, consultez Nouveautés de MSBuild 12.0.

System_CAPS_pubpropertyMetadataCount

Obtient le nombre d’entrées de métadonnées associées à l’élément.

MSBuild est désormais inclus dans Visual Studio au lieu de .NET Framework. Vous pouvez utiliser MSBuild 12.0 côte à côte avec les versions précédemment déployé avec le .NET Framework.For plus d’informations, consultez Nouveautés de MSBuild 12.0.

System_CAPS_pubpropertyMetadataNames

Obtient les noms des entrées de métadonnées associées à l’élément.

MSBuild est désormais inclus dans Visual Studio au lieu de .NET Framework. Vous pouvez utiliser MSBuild 12.0 côte à côte avec les versions précédemment déployé avec le .NET Framework.For plus d’informations, consultez Nouveautés de MSBuild 12.0.

NomDescription
System_CAPS_pubmethodCloneCustomMetadata()

Obtient la collection de métadonnées personnalisées.

MSBuild est désormais inclus dans Visual Studio au lieu de .NET Framework. Vous pouvez utiliser MSBuild 12.0 côte à côte avec les versions précédemment déployé avec le .NET Framework.For plus d’informations, consultez Nouveautés de MSBuild 12.0.

System_CAPS_pubmethodCopyMetadataTo(ITaskItem)

Copie les entrées de métadonnées personnalisées à un autre élément.

MSBuild est désormais inclus dans Visual Studio au lieu de .NET Framework. Vous pouvez utiliser MSBuild 12.0 côte à côte avec les versions précédemment déployé avec le .NET Framework.For plus d’informations, consultez Nouveautés de MSBuild 12.0.

System_CAPS_pubmethodGetMetadata(String)

Obtient la valeur de l’entrée de métadonnées spécifiée.

MSBuild est désormais inclus dans Visual Studio au lieu de .NET Framework. Vous pouvez utiliser MSBuild 12.0 côte à côte avec les versions précédemment déployé avec le .NET Framework.For plus d’informations, consultez Nouveautés de MSBuild 12.0.

System_CAPS_pubmethodRemoveMetadata(String)

Supprime l’entrée de métadonnées spécifiée de l’élément.

MSBuild est désormais inclus dans Visual Studio au lieu de .NET Framework. Vous pouvez utiliser MSBuild 12.0 côte à côte avec les versions précédemment déployé avec le .NET Framework.For plus d’informations, consultez Nouveautés de MSBuild 12.0.

System_CAPS_pubmethodSetMetadata(String, String)

Ajoute ou modifie une entrée de métadonnées personnalisées à l’élément.

MSBuild est désormais inclus dans Visual Studio au lieu de .NET Framework. Vous pouvez utiliser MSBuild 12.0 côte à côte avec les versions précédemment déployé avec le .NET Framework.For plus d’informations, consultez Nouveautés de MSBuild 12.0.

Le nombre de ITaskItem objets créés pendant une génération peut ne pas correspondant exactement aux éléments déclarés dans un fichier de projet pour les raisons suivantes :

  • Les tâches créent quelquefois des éléments qui n’ont pas été déclarées dans le fichier projet.

  • Une collection d’éléments peut être déclarée dans le fichier de projet avec des caractères génériques, ce qui peut entraîner de nombreux éléments lors de la génération.

L’exemple suivant montre le code pour une tâche qui crée un ou plusieurs répertoires.

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;
		}
	}
}
Retour au début
Afficher: