Proprietà ProjectItemInstance.ITaskItem.ItemSpec

.NET Framework (current version)

Data di pubblicazione: ottobre 2016

Implementazione di ITaskItem. Ottiene o imposta la specifica dell'elemento.

Spazio dei nomi:   Microsoft.Build.Execution
Assembly:  Microsoft.Build (in Microsoft.Build.dll)

string ITaskItem.ItemSpec { get; set; }

Valore proprietà

Type: System.String

Specifica dell'elemento.

La specifica dell'elemento è una stringa arbitraria. Se l'elemento rappresenta un file su disco, la specifica dell'elemento sarà il percorso del file.

Il ItemSpec per la seguente dichiarazione di elemento in un progetto di file è File.cs.

    <Compile Include="File.cs"/>

Nell'esempio seguente viene illustrato il codice per un'attività che crea una o più directory.

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.
            // Directories to create.
		public ITaskItem[] Directories
				return directories;

				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.
		// A project may need the subset of the inputs that were actually created, so make that available here.
		public ITaskItem[] DirectoriesCreated
				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)
						// 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);

						// Add to the list of created directories
					// 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);

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

.NET Framework
Disponibile da 4.0
Torna all'inizio