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

TaskLoggingHelper classe

 

Date de publication : novembre 2016

Fournit des méthodes de journalisation d’assistance utilisées par les tâches.

Espace de noms:   Microsoft.Build.Utilities
Assembly:  Microsoft.Build.Utilities.v4.0 (dans Microsoft.Build.Utilities.v4.0.dll)

System.Object
  System.MarshalByRefObject
    Microsoft.Build.Utilities.TaskLoggingHelper
      Microsoft.Build.Tasks.TaskLoggingHelperExtension

public class TaskLoggingHelper : MarshalByRefObject

NomDescription
System_CAPS_pubmethodTaskLoggingHelper(IBuildEngine, String)

Constructeur public qui peut être utilisé par les fabriques de tâches pour les aider à enregistrer les messages.

System_CAPS_pubmethodTaskLoggingHelper(ITask)

Initialise une nouvelle instance de la classe TaskLoggingHelper et l’associe à l’instance de tâche spécifiée.

NomDescription
System_CAPS_protpropertyBuildEngine

Obtient le moteur de génération associé à la tâche.

System_CAPS_pubpropertyHasLoggedErrors

Obtient une valeur qui indique si la tâche a consigné des erreurs via cet objet d’assistance de journalisation.

System_CAPS_pubpropertyHelpKeywordPrefix

Obtient ou définit le préfixe utilisé pour composer des mots clés d’aide à partir de noms de ressources.

System_CAPS_protpropertyTaskName

Obtient le nom de la tâche parente.

System_CAPS_pubpropertyTaskResources

Obtient ou définit les ressources spécifiques à la culture utilisées par les méthodes de journalisation.

NomDescription
System_CAPS_pubmethodCreateObjRef(Type)

Crée un objet qui contient toutes les informations requises pour générer un proxy permettant de communiquer avec un objet distant.(Hérité de MarshalByRefObject.)

System_CAPS_pubmethodEquals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.(Hérité de Object.)

System_CAPS_pubmethodExtractMessageCode(String, String)

Extrait le préfixe du code de message de la chaîne de message complète donnée.

System_CAPS_protmethodFinalize()

Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)

System_CAPS_pubmethodFormatResourceString(String, Object[])

Charge la chaîne de ressource spécifiée et la met éventuellement en forme à l’aide des arguments fournis.

System_CAPS_pubmethodFormatString(String, Object[])

Met en forme la chaîne donnée à l’aide des arguments fournis.

System_CAPS_pubmethodGetHashCode()

Fait office de fonction de hachage par défaut.(Hérité de Object.)

System_CAPS_pubmethodGetLifetimeService()

Récupère l’objet de service de durée de vie actuelle qui contrôle la stratégie de durée de vie de cette instance.(Hérité de MarshalByRefObject.)

System_CAPS_pubmethodGetResourceMessage(String)

Obtient le message à partir de la ressource dans la bibliothèque de tâches.

System_CAPS_pubmethodGetType()

Obtient le Type de l'instance actuelle.(Hérité de Object.)

System_CAPS_pubmethodInitializeLifetimeService()

InitializeLifetimeService est appelée lorsque l’objet distant est activé.

Cette méthode détermine la durée pendant laquelle la durée de vie de l’objet sera.

Thread-safe. Toutefois, InitializeLifetimeService et MarkAsInactive doivent être appelée uniquement dans cet ordre, ensemble ou pas du tout et non plusieurs fois.(Remplace MarshalByRefObject.InitializeLifetimeService().)

System_CAPS_pubmethodLogCommandLine(MessageImportance, String)

Consigne la ligne de commande pour un outil sous-jacent, un fichier exécutable ou une commande shell d’une tâche selon le niveau d’importance spécifié.

System_CAPS_pubmethodLogCommandLine(String)

Enregistre la ligne de commande pour un outil sous-jacent, un fichier exécutable ou une commande shell d’une tâche.

System_CAPS_pubmethodLogCriticalMessage(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Enregistre un message critique à l’aide de la chaîne spécifiée et autres détails du message.

Thread-safe.

System_CAPS_pubmethodLogError(String, Object[])

Enregistre une erreur avec le message spécifié.

System_CAPS_pubmethodLogError(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Enregistre une erreur à l’aide du message spécifié et d’autres détails sur l’erreur.

System_CAPS_pubmethodLogErrorFromException(Exception)

Consigne une erreur en utilisant le message de l’exception donnée.

System_CAPS_pubmethodLogErrorFromException(Exception, Boolean)

Consigne une erreur avec le message, et éventuellement la trace de la pile, de l’exception donnée.

System_CAPS_pubmethodLogErrorFromException(Exception, Boolean, Boolean, String)

Consigne une erreur avec le message, et éventuellement la trace de la pile, à partir de l’exception donnée et toutes les exceptions internes.

System_CAPS_pubmethodLogErrorFromResources(String, Object[])

Consigne une erreur en utilisant la chaîne de ressource spécifiée.

System_CAPS_pubmethodLogErrorFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Consigne une erreur en utilisant la chaîne de ressource spécifiée et d’autres détails sur l’erreur.

System_CAPS_pubmethodLogErrorWithCodeFromResources(String, Object[])

Consigne une erreur avec un code d’erreur en utilisant la chaîne de ressource spécifiée.

System_CAPS_pubmethodLogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[])

Consigne une erreur en utilisant la chaîne de ressource spécifiée et d’autres détails sur l’erreur.

System_CAPS_pubmethodLogExternalProjectFinished(String, String, String, Boolean)

Aide à consigner l’événement de build ExternalProjectFinishedEventArgs personnalisé.

System_CAPS_pubmethodLogExternalProjectStarted(String, String, String, String)

Aide à enregistrer l’événement de build ExternalProjectStartedEventArgs personnalisé.

System_CAPS_pubmethodLogMessage(MessageImportance, String, Object[])

Consigne un message avec la chaîne et l’importance spécifiées.

System_CAPS_pubmethodLogMessage(String, Object[])

Consigne un message avec la chaîne spécifiée.

System_CAPS_pubmethodLogMessage(String, String, String, String, Int32, Int32, Int32, Int32, MessageImportance, String, Object[])

Enregistre un message à l’aide de la chaîne spécifiée et autres détails du message.

Thread-safe.

System_CAPS_pubmethodLogMessageFromResources(MessageImportance, String, Object[])

Consigne un message avec la chaîne de ressource et l’importance spécifiées.

System_CAPS_pubmethodLogMessageFromResources(String, Object[])

Consigne un message avec la chaîne de ressource spécifiée.

System_CAPS_pubmethodLogMessageFromText(String, MessageImportance)

Consigne un message d’erreur ou un avertissement à partir de la ligne de texte donnée.

System_CAPS_pubmethodLogMessagesFromFile(String)

Journaux des erreurs, avertissements et messages pour chaque ligne de texte dans le fichier donné.

System_CAPS_pubmethodLogMessagesFromFile(String, MessageImportance)

Consigne les erreurs, avertissements et messages pour chaque ligne de texte dans le fichier donné. Consigne également l’importance des messages.

System_CAPS_pubmethodLogMessagesFromStream(TextReader, MessageImportance)

Consigne un message d’erreur ou un avertissement à partir du flux donné.

System_CAPS_pubmethodLogWarning(String, Object[])

Consigne un avertissement avec le message spécifié.

System_CAPS_pubmethodLogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Enregistre un avertissement à l’aide du message spécifié et d’autres détails sur l’avertissement.

System_CAPS_pubmethodLogWarningFromException(Exception)

Consigne un avertissement à l’aide du message de l’exception spécifiée.

System_CAPS_pubmethodLogWarningFromException(Exception, Boolean)

Consigne un avertissement en utilisant le message, et éventuellement la trace de la pile, de l’exception donnée.

System_CAPS_pubmethodLogWarningFromResources(String, Object[])

Consigne un avertissement à l’aide de la chaîne de ressource spécifiée.

System_CAPS_pubmethodLogWarningFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])

Consigne un avertissement avec la chaîne de ressources spécifiée et d’autres détails d’avertissement.

System_CAPS_pubmethodLogWarningWithCodeFromResources(String, Object[])

Consigne un avertissement avec un code d’avertissement utilisant la chaîne de ressource spécifiée.

System_CAPS_pubmethodLogWarningWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[])

Consigne un avertissement avec un code d’avertissement utilisant la chaîne de ressources spécifiée et d’autres détails d’avertissement.

System_CAPS_pubmethodMarkAsInactive()

Cela notifie TaskLoggingHelper n’est plus nécessaire.

System_CAPS_protmethodMemberwiseClone()

Crée une copie superficielle du Object actuel.(Hérité de Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Crée une copie superficielle d’actuel MarshalByRefObject objet.(Hérité de MarshalByRefObject.)

System_CAPS_pubmethodToString()

Retourne une chaîne qui représente l'objet actuel.(Hérité de Object.)

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

.NET Framework
Disponible depuis 2.0

Tous les membres statiques publics ( Shared en Visual Basic) de ce type sont thread-safe. Les membres d’instance n’ont pas la garantie d’être thread-safe.

Retour au début
Afficher: