ToolTaskExtension Třída

Definice

Malá střední třída mezi ToolTask a třídami, která ji používá v XMakeTasks, implementaci funkcí, které nechcete zveřejnit v nástrojíchA small intermediate class between ToolTask and classes using it in XMakeTasks, implementing functionality that we didn't want to expose in Utilities

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

public ref class ToolTaskExtension abstract : Microsoft::Build::Utilities::ToolTask
public abstract class ToolTaskExtension : Microsoft.Build.Utilities.ToolTask
type ToolTaskExtension = class
    inherit ToolTask
Public MustInherit Class ToolTaskExtension
Inherits ToolTask
Dědičnost
ToolTaskExtension
Odvozené

Poznámky

Tato třída musí být veřejná, protože úlohy odvozené od nich jsou veřejné.This class has to be public because the tasks that derive from it are public. V ideálním případě by měla být tato třída interní, ale jazyk C# nepovoluje, aby byla základní třída méně dostupná než její odvozené třídy.Ideally we would like this class to be internal, but C# does not allow a base class to be less accessible than its derived classes.

Vlastnosti

Bag

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

Získá kolekci parametrů používaných odvozenou třídou Task.Gets the collection of parameters used by the derived task class.

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

(Zděděno od ToolTask)
EnvironmentOverride
Zastaralé.

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

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
HasLoggedErrors

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

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

HasLoggedErrors

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

(Zděděno od ToolTask)
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

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

Načte instanci třídy TaskLoggingHelperExtension obsahující metody protokolování úloh.Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

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.

(Zděděno od ToolTask)
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

(Zděděno od ToolTask)
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

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
ToolCanceled

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

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
UseNewLineSeparatorInResponseFile

Když je nastaveno na hodnotu true, soubor odezvy bude používat nové řádky místo mezer k oddělení argumentů.When set to true, the response file will use new lines instead of spaces to separate arguments.

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.

(Zděděno od ToolTask)

Metody

AddCommandLineCommands(CommandLineBuilderExtension)

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

Vyplní poskytnuté CommandLineBuilderExtension těmito přepínači a dalšími informacemi, které nemůžou přejít do souboru odpovědí a musí přejít přímo na příkazový řádek.Fills the provided CommandLineBuilderExtension with those switches and other information that can't go into a response file and must go directly onto the command line.

AddResponseFileCommands(CommandLineBuilderExtension)

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

Vyplní poskytnuté CommandLineBuilderExtension těmito přepínači a dalšími informacemi, které mohou přejít do souboru odpovědí.Fills the provided CommandLineBuilderExtension with those switches and other information that can go into a response file.

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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
GenerateCommandLineCommands()

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

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.

(Zděděno od ToolTask)
GenerateResponseFileCommands()

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

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

GetBoolParameterWithDefault(String, Boolean)

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

Získá parametr bool a vrátí výchozí hodnotu, pokud není přítomen v zatřiďovací tabulce.Get a bool parameter and return a default if its not present in the hash table.

GetHashCode()

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

(Zděděno od Object)
GetIntParameterWithDefault(String, Int32)

Toto rozhraní API podporuje produktovou infrastrukturu a není určené k použití přímo z uživatelského kódu.

Získá parametr int a vrátí výchozí hodnotu, pokud není přítomen v zatřiďovací tabulce.Get an int parameter and return a default if its not present in the hash table.

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.

(Zděděno od ToolTask)
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

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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.

(Zděděno od ToolTask)
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)

(Zděděno od ToolTask)
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)

(Zděděno od ToolTask)
ResponseFileEscape(String)

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

(Zděděno od ToolTask)
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

(Zděděno od ToolTask)
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

(Zděděno od ToolTask)

Platí pro