Exporter (0) Imprimer
Développer tout
Cet article a fait l'objet d'une traduction automatique. Déplacez votre pointeur sur les phrases de l'article pour voir la version originale de ce texte. Informations supplémentaires.
Traduction
Source

TaskLoggingHelper, classe

Fournit des méthodes d'assistance à l'enregistrement 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)

public class TaskLoggingHelper : MarshalByRefObject

Le type TaskLoggingHelper expose les membres suivants.

  NomDescription
Méthode publiqueTaskLoggingHelper(ITask)Initialise une nouvelle instance de la classe TaskLoggingHelper et l'associe à l'instance de tâche spécifiée.
Méthode publiqueTaskLoggingHelper(IBuildEngine, String)Constructeur public qui peut être utilisé par les fabriques de tâches pour les aider à enregistrer les messages.
Début

  NomDescription
Propriété protégéeBuildEngineObtient le moteur de génération qui est associé à la tâche.
Propriété publiqueHasLoggedErrorsObtient une valeur indiquant si la tâche a enregistré des erreurs par le biais de cet objet d'assistance à l'enregistrement.
Propriété publiqueHelpKeywordPrefixObtient ou définit le préfixe utilisé pour composer des mots clés d'aide à partir de noms de ressources.
Propriété protégéeTaskNameObtient le nom de la tâche parent.
Propriété publiqueTaskResourcesObtient ou définit les ressources spécifiques à la culture utilisées par les méthodes d'enregistrement.
Début

  NomDescription
Méthode publiqueCreateObjRefCrée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant. (Hérité de MarshalByRefObject.)
Méthode publiqueEquals(Object)Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.)
Méthode publiqueExtractMessageCodeExtrait le préfixe du code du message à partir de la chaîne de message complète donnée.
Méthode protégéeFinalize 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.)
Méthode publiqueFormatResourceStringCharge la chaîne de ressource spécifiée et la met en forme (en option) à l'aide des arguments donnés.
Méthode publiqueFormatStringMet en forme la chaîne donnée à l'aide des arguments donnés.
Méthode publiqueGetHashCodeSert de fonction de hachage par défaut. (Hérité de Object.)
Méthode publiqueGetLifetimeServiceRécupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject.)
Méthode publiqueGetResourceMessageObtient le message de la ressource dans la bibliothèque de tâches.
Méthode publiqueGetTypeObtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publiqueInitializeLifetimeServiceInitializeLifetimeService est appelé lorsque l'objet distant est activé. Cette méthode détermine la durée de vie de l'objet.Thread safe. Toutefois, InitializeLifetimeService et MarkAsInactive doivent être appelés uniquement dans cet ordre, ensemble ou pas du tout, et pas plus d'une fois. (Substitue MarshalByRefObject.InitializeLifetimeService().)
Méthode publiqueLogCommandLine(String)Enregistre la ligne de commande pour un outil sous-jacent, un fichier exécutable ou une commande Shell d'une tâche.
Méthode publiqueLogCommandLine(MessageImportance, String)Enregistre la ligne de commande pour un outil sous-jacent, un fichier exécutable ou une commande Shell d'une tâche à l'aide du niveau d'importance spécifié.
Méthode publiqueLogCriticalMessageEnregistre un message critique à l'aide de la chaîne spécifiée et d'autres détails de message. Thread safe.
Méthode publiqueLogError(String, Object[])Enregistre une erreur avec le message spécifié.
Méthode publiqueLogError(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Enregistre une erreur à l'aide du message spécifié et d'autres détails d'erreur.
Méthode publiqueLogErrorFromException(Exception)Enregistre une erreur à l'aide du message à partir de l'exception donnée.
Méthode publiqueLogErrorFromException(Exception, Boolean)Enregistre une erreur à l'aide du message, et la trace de la pile (en option), à partir de l'exception donnée.
Méthode publiqueLogErrorFromException(Exception, Boolean, Boolean, String)Enregistre une erreur à l'aide du message, et éventuellement la trace de la pile, à partir de l'exception donnée et toutes exceptions internes.
Méthode publiqueLogErrorFromResources(String, Object[])Enregistre une erreur à l'aide de la chaîne de ressource spécifiée.
Méthode publiqueLogErrorFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Enregistre une erreur à l'aide de la chaîne de ressource spécifiée et d'autres détails d'erreur.
Méthode publiqueLogErrorWithCodeFromResources(String, Object[])Enregistre une erreur avec un code d'erreur à l'aide de la chaîne de ressource spécifiée.
Méthode publiqueLogErrorWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[])Enregistre une erreur à l'aide de la chaîne de ressource spécifiée et d'autres détails d'erreur.
Méthode publiqueLogExternalProjectFinishedAide à enregistrer l'événement de build ExternalProjectFinishedEventArgs personnalisé.
Méthode publiqueLogExternalProjectStartedAide à enregistrer l'événement de build ExternalProjectStartedEventArgs personnalisé.
Méthode publiqueLogMessage(String, Object[])Enregistre un message avec la chaîne spécifiée.
Méthode publiqueLogMessage(MessageImportance, String, Object[])Enregistre un message avec la chaîne et l'importance spécifiées.
Méthode publiqueLogMessage(String, String, String, String, Int32, Int32, Int32, Int32, MessageImportance, String, Object[])Enregistre un message à l'aide de la chaîne spécifiée et d'autres détails de message. Thread safe.
Méthode publiqueLogMessageFromResources(String, Object[])Enregistre un message avec la chaîne de ressource spécifiée.
Méthode publiqueLogMessageFromResources(MessageImportance, String, Object[])Enregistre un message avec la chaîne de ressource et l'importance spécifiées.
Méthode publiqueLogMessageFromTextEnregistre un message d'erreur ou d'avertissement à partir de la ligne donnée de texte.
Méthode publiqueLogMessagesFromFile(String)Enregistre les erreurs, avertissements et messages pour chaque ligne de texte dans le fichier donné.
Méthode publiqueLogMessagesFromFile(String, MessageImportance)Enregistre les erreurs, avertissements et messages pour chaque ligne de texte dans le fichier donné. Enregistre également l'importance des messages.
Méthode publiqueLogMessagesFromStreamEnregistre un message d'erreur ou d'avertissement à partir du flux donné.
Méthode publiqueLogWarning(String, Object[])Enregistre un avertissement avec le message spécifié.
Méthode publiqueLogWarning(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Enregistre un avertissement à l'aide du message spécifié et d'autres détails d'avertissement.
Méthode publiqueLogWarningFromException(Exception)Enregistre un avertissement à l'aide du message à partir de l'exception spécifiée.
Méthode publiqueLogWarningFromException(Exception, Boolean)Enregistre un avertissement à l'aide du message, et la trace de la pile (en option), à partir de l'exception donnée.
Méthode publiqueLogWarningFromResources(String, Object[])Enregistre un avertissement à l'aide de la chaîne de ressource spécifiée.
Méthode publiqueLogWarningFromResources(String, String, String, String, Int32, Int32, Int32, Int32, String, Object[])Enregistre un avertissement à l'aide de la chaîne de ressource spécifiée et d'autres détails d'avertissement.
Méthode publiqueLogWarningWithCodeFromResources(String, Object[])Enregistre un avertissement avec un code d'avertissement à l'aide de la chaîne de ressource spécifiée.
Méthode publiqueLogWarningWithCodeFromResources(String, String, Int32, Int32, Int32, Int32, String, Object[])Enregistre un avertissement avec un code d'avertissement à l'aide de la chaîne de ressource spécifiée et d'autres détails d'avertissement.
Méthode publiqueMarkAsInactiveIndique à cet objet TaskLoggingHelper qu'il n'est plus nécessaire.
Méthode protégéeMemberwiseClone()Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
Méthode protégéeMemberwiseClone(Boolean)Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject.)
Méthode publiqueToStringRetourne une chaîne qui représente l'objet actif. (Hérité de Object.)
Début

L'exemple suivant affiche 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

Pris en charge dans : 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (rôle principal du serveur non pris en charge), Windows Server 2008 R2 (rôle principal du serveur pris en charge avec SP1 ou version ultérieure ; Itanium non pris en charge)

Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Ajouts de la communauté

AJOUTER
Microsoft réalise une enquête en ligne pour recueillir votre opinion sur le site Web de MSDN. Si vous choisissez d’y participer, cette enquête en ligne vous sera présentée lorsque vous quitterez le site Web de MSDN.

Si vous souhaitez y participer,
Afficher:
© 2015 Microsoft