ToolTask Třída

Definice

Základní třída použitá pro úlohy, které vytváří spustitelný soubor.Base class used for tasks that spawn an executable. Tato třída implementuje vlastnost ToolPath, která se dá použít k přepsání výchozí cesty.This class implements the ToolPath property which can be used to override the default path.

public ref class ToolTask abstract : Microsoft::Build::Utilities::Task, Microsoft::Build::Framework::ICancelableTask
public ref class ToolTask abstract : Microsoft::Build::Utilities::Task
public abstract class ToolTask : Microsoft.Build.Utilities.Task, Microsoft.Build.Framework.ICancelableTask
public abstract class ToolTask : Microsoft.Build.Utilities.Task
type ToolTask = class
    inherit Task
    interface ICancelableTask
    interface ITask
type ToolTask = class
    inherit Task
Public MustInherit Class ToolTask
Inherits Task
Implements ICancelableTask
Public MustInherit Class ToolTask
Inherits Task
Dědičnost
ToolTask
Odvozené
Implementuje

Konstruktory

ToolTask()

Chráněný konstruktorProtected constructor

ToolTask(ResourceManager)

Chráněný konstruktorProtected constructor

ToolTask(ResourceManager, String)

Chráněný konstruktorProtected constructor

Vlastnosti

BuildEngine

Modul buildu tuto vlastnost automaticky nastaví, aby bylo možné úlohy volat zpět do této vlastnosti.The build engine automatically sets this property to allow tasks to call back into it.

(Zděděno od Task)
BuildEngine2

Modul buildu tuto vlastnost automaticky nastaví, aby bylo možné úlohy volat zpět do této vlastnosti.The build engine automatically sets this property to allow tasks to call back into it. Toto je vlastnost pohodlí, aby autoři úloh, které dědí z této třídy, nemuseli přetypovat hodnotu z IBuildEngine na IBuildEngine2.This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(Zděděno od Task)
BuildEngine3

Načte IBuildEngine3 verzi rozhraní modulu sestavení poskytované hostitelem.Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(Zděděno od Task)
BuildEngine4

Načte IBuildEngine4 verzi rozhraní modulu sestavení poskytované hostitelem.Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(Zděděno od Task)
BuildEngine5

Načte IBuildEngine5 verzi rozhraní modulu sestavení poskytované hostitelem.Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(Zděděno od Task)
BuildEngine6

Načte IBuildEngine6 verzi rozhraní modulu sestavení poskytované hostitelem.Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(Zděděno od Task)
BuildEngine7

Získá verzi rozhraní modulu sestavení poskytované hostitelem.Gets the version of the build engine interface provided by the host.

(Zděděno od Task)
EchoOff

Když se nastaví na true, předá/Q do cmd.exe příkazového řádku tak, aby příkazový řádek nezískal příkaz echo-Ed v STDOUT.When set to true, it passes /Q to the cmd.exe command line such that the command line does not get echo-ed on stdout

EnvironmentOverride
Zastaralé.

Získá hodnotu přepsání cesty.Gets the Path override value.

EnvironmentVariables

Pole stejných párů oddělených proměnných prostředí, které by měly být předány do vytvořeného spustitelného souboru, kromě (nebo selektivního přepsání) normálního bloku prostředí.Array of equals-separated pairs of environment variables that should be passed to the spawned executable, in addition to (or selectively overriding) the regular environment block.

ExitCode

Návratový kód vytvořeného procesu.The return code of the spawned process. Pokud úloha nahlásila chyby, ale proces měl ukončovací kód 0 (úspěch), nastaví se hodnota-1.If the task logged any errors, but the process had an exit code of 0 (success), this will be set to -1.

HasLoggedErrors

Bez ohledu na to, jestli tento ToolTask zaznamenal nějaké chybyWhether this ToolTask has logged any errors

HelpKeywordPrefix

Získá nebo nastaví předponu používanou k vytváření klíčových slov v názvech prostředků v řetězci.Gets or sets the prefix used to compose help keywords from string resource names. Pokud úloha nemá klíčová slova, která jsou přidružená ke svým zprávám, může tuto vlastnost ignorovat nebo ji nastavit na hodnotu null.If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. Pokud je předpona nastavena na prázdný řetězec, názvy prostředků řetězců budou použity jako klíčová slova help.If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. Příklad použití této předpony naleznete v metodě TaskLoggingHelper. LogErrorWithCodeFromResources (String, Object []).For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(Zděděno od Task)
HostObject

Modul sestavení nastavuje tuto vlastnost, pokud má rozhraní IDE hostitele přidružený objekt hostitele s touto konkrétní úlohou.The build engine sets this property if the host IDE has associated a host object with this particular task.

(Zděděno od Task)
Log

Načte instanci třídy TaskLoggingHelper obsahující metody protokolování úloh.Gets an instance of a TaskLoggingHelper class containing task logging methods. TaskLoggingHelper je objekt MarshallByRef, který musí být volán MarkAsInactive, Pokud nadřazená úloha provádí doménu AppDomain a zařazování tohoto objektu do něj.The taskLoggingHelper is a MarshallByRef object which needs to have MarkAsInactive called if the parent task is making the appdomain and marshaling this object into it. Pokud doména AppDomain není uvolněna na konci provádění úlohy a metoda MarkAsInactive není volána, výsledkem bude nevrácení instancí úloh v doméně aplikace, kterou byl úkol vytvořen v rámci.If the appdomain is not unloaded at the end of the task execution and the MarkAsInactive method is not called this will result in a leak of the task instances in the appdomain the task was created within.

(Zděděno od Task)
LogStandardErrorAsError

Měly by se všechny zprávy přijaté do standardního streamu chyb zaprotokolovat jako chyby.Should ALL messages received on the standard error stream be logged as errors.

ResponseFileEncoding

Přepsatelné vlastnosti určující kódování souboru odpovědí, UTF8 ve výchozím nastavení.Overridable property specifying the encoding of the response file, UTF8 by default

StandardErrorEncoding

Přepsatelné vlastnosti určující kódování zachyceného standardního chybového proudu úlohyOverridable property specifying the encoding of the captured task standard error stream

StandardErrorImportance

Parametr úlohy: důležitost, se kterou se má protokolovat text ze standardního streamu chyb.Task Parameter: Importance with which to log text from the standard error stream.

StandardErrorImportanceToUse

Skutečná důležitost, na které budou protokolovány standardní chybové zprávy.The actual importance at which standard error messages will be logged.

StandardErrorLoggingImportance

Důležitost, se kterou chcete protokolovat text ze standardního streamu chyb.Importance with which to log text from the standard error stream.

StandardOutputEncoding

Přepsatelné vlastnosti určující kódování zachyceného standardního výstupního datového proudu zaznamenaného úkoluOverridable property specifying the encoding of the captured task standard output stream

StandardOutputImportance

Parametr úlohy: důležitost, se kterou se má protokolovat text z standardního výstupního proudu.Task Parameter: Importance with which to log text from the standard out stream.

StandardOutputImportanceToUse

Skutečná důležitost, se kterou se budou protokolovat standardní zprávy.The actual importance at which standard out messages will be logged.

StandardOutputLoggingImportance

Důležitost, se kterou chcete protokolovat text v rámci standardního výstupního proudu.Importance with which to log text from in the standard out stream.

TaskProcessTerminationTimeout

Časový limit čekání na ukončení úkolu před jeho zrušením.A timeout to wait for a task to terminate before killing it. V milisekundách.In milliseconds.

TaskResources

Získá nebo nastaví prostředky specifické pro jazykovou verzi úlohy.Gets or sets the task's culture-specific resources. Odvozené třídy by měly registrovat své prostředky buď během konstrukce, nebo prostřednictvím této vlastnosti, pokud mají lokalizované řetězce.Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Zděděno od Task)
Timeout

Viditelná vlastnost projektu, která umožňuje uživateli zadat dobu, po jejímž uplynutí je ukončen spustitelný soubor úlohy.Project visible property that allows the user to specify an amount of time after which the task executable is terminated.

ToolCanceled

Používá se k signalizaci, když se nástroj zruší.Used to signal when a tool has been cancelled.

ToolExe

Projekty mohou tuto hodnotu nastavit, aby potlačily nástroje úkolu.Projects may set this to override a task's ToolName. Úkoly mohou tuto úlohu přepsat, aby se zabránilo tomu.Tasks may override this to prevent that.

ToolName

Implementováno odvozenou třídou.Implemented by the derived class. Vrátí řetězec, který představuje název podkladového typu. SPUSTITELNÝ soubor, který se má spustit, například "resgen.exe", používá se pouze metoda getter pro ToolExe.Returns a string which is the name of the underlying .EXE to run e.g. "resgen.exe" Only used by the ToolExe getter.

ToolPath

Vlastnost Visible projektu umožňuje uživateli přepsat cestu ke spustitelnému souboru.Project-visible property allows the user to override the path to the executable.

UseCommandProcessor

Pokud je nastavena hodnota true, úloha nástroje vytvoří dávkový soubor pro příkazový řádek a provede jej pomocí příkazového procesoru namísto provedení příkazu přímo.When set to true, the tool task will create a batch file for the command-line and execute that using the command-processor, rather than executing the command directly.

YieldDuringToolExecution

Při nastavení na hodnotu true bude tato úloha při provádění úlohy vracet uzel.When set to true, this task will yield the node when its task is executing.

Metody

AdjustCommandsForOperatingSystem(String)

Nahraďte zpětná lomítka pomocí oddělovačů cest specifických pro operační systém, s výjimkou případů, kdy je pravděpodobná zpětné lomítko.Replace backslashes with OS-specific path separators, except when likely that the backslash is intentional.

CallHostObjectToExecute()

Očekáváme, že úlohy přepíší tuto metodu, pokud podporují objekty hostitele.We expect the tasks to override this method, if they support host objects. Implementace by měla volat do objektu hostitele, aby provedla skutečnou práci úkolu.The implementation should call into the host object to perform the real work of the task. Například pro úlohy kompilátoru, jako je CSC a vbc, by tato metoda volala metodu Compile () na objekt hostitele.For example, for compiler tasks like Csc and Vbc, this method would call Compile() on the host object.

Cancel()

Zruší proces, který úlohu spouští, a požádá ho, aby se krátce zavřel, a pak po krátké době vynutí ukončení.Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination.

DeleteTempFile(String)

Odstraňte dočasný soubor.Delete temporary file. Pokud odstranění z nějakého důvodu selže (např. soubor uzamčen antivirovým programem), volání nevyvolá výjimku.If the delete fails for some reason (e.g. file locked by anti-virus) then the call will not throw an exception. Místo toho bude zaznamenáno upozornění, ale sestavení selže.Instead a warning will be logged, but the build will not fail.

Equals(Object)

Určí, zda se zadaný objekt rovná aktuálnímu objektu.Determines whether the specified object is equal to the current object.

(Zděděno od Object)
Execute()

Tato metoda vyvolá nástroj se zadanými parametry.This method invokes the tool with the given parameters.

ExecuteTool(String, String, String)

Zapisuje dočasnou odpověď soubor a prostředí – spustí požadovaný nástroj.Writes out a temporary response file and shell-executes the tool requested. Povoluje souběžné protokolování výstupu nástroje.Enables concurrent logging of the output of the tool.

GenerateCommandLineCommands()

Vrátí řetězec s těmito přepínači a dalšími informacemi, které nemohou přejít do souboru odpovědí a musí jít přímo do příkazového řádku.Returns a string with those switches and other information that can't go into a response file and must go directly onto the command line. Volá se po ValidateParameters a SkipTaskExecution.Called after ValidateParameters and SkipTaskExecution

GenerateFullPathToTool()

Získá plně kvalifikovaný název nástroje.Gets the fully qualified tool name. By měl vrátit ToolExe, pokud by ToolTask měl vyhledat nástroj v systémové cestě.Should return ToolExe if ToolTask should search for the tool in the system path. Pokud je nastavená ToolPath, ignoruje se.If ToolPath is set, this is ignored.

GenerateResponseFileCommands()

Vrátí řetězec s těmito přepínači a dalšími informacemi, které mohou přejít do souboru odpovědí.Returns a string with those switches and other information that can go into a response file. Volá se po ValidateParameters a SkipTaskExecution.Called after ValidateParameters and SkipTaskExecution

GetHashCode()

Slouží jako výchozí funkce hash.Serves as the default hash function.

(Zděděno od Object)
GetProcessStartInfo(String, String, String)

Inicializuje informace požadované k vytvoření procesu, který spouští nástroj.Initializes the information required to spawn the process executing the tool.

GetResponseFileSwitch(String)

Vrátí přepínač příkazového řádku používaný spustitelným souborem nástroje k určení souboru odpovědí.Returns the command line switch used by the tool executable to specify the response file. Bude volána pouze v případě, že úloha vrátila neprázdný řetězec z GetResponseFileCommands, který je volán po ValidateParameters, SkipTaskExecution a GetResponseFileCommandsWill only be called if the task returned a non empty string from GetResponseFileCommands Called after ValidateParameters, SkipTaskExecution and GetResponseFileCommands

GetType()

Získá Type aktuální instanci.Gets the Type of the current instance.

(Zděděno od Object)
GetWorkingDirectory()

Získá pracovní adresář, který má být použit pro daný proces.Gets the working directory to use for the process. By měla vracet hodnotu null, pokud má ToolTask použít aktuální adresář.Should return null if ToolTask should use the current directory.

HandleTaskExecutionErrors()

Umožňuje nástroji zpracovat návratový kód.Allows tool to handle the return code. Tato metoda bude volána pouze s nenulovým exitCode.This method will only be called with non-zero exitCode.

InitializeHostObject()

Očekáváme, že tato metoda bude přepsána v případě, že podporují objekty hostitele.We expect tasks to override this method if they support host objects. Implementace by měla zajistit, aby byl objekt hostitele připraven provést skutečnou práci úkolu.The implementation should make sure that the host object is ready to perform the real work of the task.

LogEventsFromTextOutput(String, MessageImportance)

Volá metodu v TaskLoggingHelper k analýze jednoho řádku textu, aby se zobrazily chyby nebo varování v kanonickém formátu.Calls a method on the TaskLoggingHelper to parse a single line of text to see if there are any errors or warnings in canonical format. To může v případě potřeby přepsat odvozenou třídou.This can be overridden by the derived class if necessary.

LogPathToTool(String, String)

Zaznamená název nástroje a cestu, ze které se spouští.Logs the tool name and the path from where it is being run.

LogToolCommand(String)

Zaznamená vlastní příkazový řádek, který se má spustit (nebo co úkol chce zobrazit v protokolu).Logs the actual command line about to be executed (or what the task wants the log to show)

MemberwiseClone()

Vytvoří kopii aktuálního seznamu Object .Creates a shallow copy of the current Object.

(Zděděno od Object)
ProcessStarted()

Přepsatelné funkce volané za Start() v ExecuteTool(String, String, String)Overridable function called after Start() in ExecuteTool(String, String, String)

ResponseFileEscape(String)

Přepsatelné metody pro řídicí obsah souboru odpovědíOverridable method to escape content of the response file

SkipTaskExecution()

Vrátí hodnotu true, pokud není nutné provedení úlohy.Returns true if task execution is not necessary. Spuštěno po ValidateParametersExecuted after ValidateParameters

ToString()

Vrátí řetězec, který představuje aktuální objekt.Returns a string that represents the current object.

(Zděděno od Object)
ValidateParameters()

Implementováno v odvozené tříděImplemented in the derived class

Platí pro