Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Clase RequiredAttribute

 

Publicado: octubre de 2016

Define el atributo de metadatos que los autores de tareas utilizan para identificar propiedades de tarea necesarias. Propiedades de la tarea con este atributo deben tener un valor especificado cuando se ejecuta la tarea.

MSBuild ahora se incluye en Visual Studio en lugar de .NET Framework. Puede usar MSBuild 12.0 en paralelo con las versiones implementadas previamente con .NET Framework. para obtener más información, consulte Novedades de MSBuild 12.0.

Espacio de nombres:   Microsoft.Build.Framework
Ensamblado:  Microsoft.Build.Framework (en Microsoft.Build.Framework.dll)

System.Object
  System.Attribute
    Microsoft.Build.Framework.RequiredAttribute

[AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple = false, 
	Inherited = false)]
public sealed class RequiredAttribute : Attribute

NombreDescripción
System_CAPS_pubmethodRequiredAttribute()

Inicializa una nueva instancia de la clase RequiredAttribute.

MSBuild ahora se incluye en Visual Studio en lugar de .NET Framework. Puede usar MSBuild 12.0 en paralelo con las versiones implementadas previamente con .NET Framework. para obtener más información, consulte Novedades de MSBuild 12.0.

NombreDescripción
System_CAPS_pubpropertyTypeId

(Heredado de Attribute).

NombreDescripción
System_CAPS_pubmethodEquals(Object)

(Heredado de Attribute).

System_CAPS_pubmethodGetHashCode()

(Heredado de Attribute).

System_CAPS_pubmethodGetType()

(Heredado de Object).

System_CAPS_pubmethodIsDefaultAttribute()

(Heredado de Attribute).

System_CAPS_pubmethodMatch(Object)

(Heredado de Attribute).

System_CAPS_pubmethodToString()

(Heredado de Object).

Si una propiedad marcada con este atributo no se asigna un valor cuando se invoca la tarea, se producirá un error en la compilación.

Para obtener más información sobre el uso de atributos, vea Extender metadatos mediante atributos.

En el ejemplo siguiente se muestra el código para una tarea que crea uno o varios directorios.

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

Para ejecutar esta tarea use un archivo de proyecto como:

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <Target Name="MyTarget">
        <MkDir Directories="NewDir" />
    </Target>
</Project>

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Volver al principio
Mostrar: