Freigeben über


ToolTaskExtension-Basisklasse

Viele Aufgaben erben von der ToolTaskExtension-Klasse, die von der ToolTask-Klasse erbt, die wiederum von der Task-Klasse erbt. Diese Vererbungskette fügt mehrere Parameter zu den Aufgaben hinzu, die davon abgeleitet werden. Diese Parameter werden in diesem Dokument aufgeführt.

Parameter

In der folgenden Tabelle werden die Parameter der Basisklassen beschrieben.

Parameter

Beschreibungen

BuildEngine

Optionaler IBuildEngine-Parameter.

Gibt die Build-Engine-Schnittstelle für Aufgaben an. Das Buildmodul legt diesen Parameter automatisch fest, um Rückrufe durch Aufgaben zuzulassen.

BuildEngine2

Optionaler IBuildEngine2-Parameter.

Gibt die Build-Engine-Schnittstelle für Aufgaben an. Das Buildmodul legt diesen Parameter automatisch fest, um Rückrufe durch Aufgaben zuzulassen.

Dies ist eine benutzerfreundliche Eigenschaft, so dass Aufgabenautoren, die von dieser Klasse erben, nicht den Wert von IBuildEngine in IBuildEngine2umwandeln müssen.

BuildEngine3

Optionaler IBuildEngine3-Parameter.

Gibt die vom Host bereitgestellte Buildmodulschnittstelle an.

EchoOff

Optionaler bool-Parameter.

Bei Festlegung auf true übergibt diese Aufgabe /Q an die cmd.exe-Befehlszeile, sodass die Befehlszeile nicht nach stdout kopiert werden wird.

EnvironmentVariables

Optionale String-Arrayparameter.

Array von Paaren von Umgebungsvariablen, durch Gleichheitszeichen getrennt. Diese Variablen werden an die erzeugte ausführbare Datei übergeben, neben dem regulären Umgebungsblock oder diesen selektiv überschreibend.

ExitCode

Optionaler schreibgeschützter Int32-Ausgabeparameter.

Gibt den vom ausgeführten Befehl bereitgestellten Exitcode an. Wenn die Aufgabe Fehler protokolliert, aber der Prozess einen Beendigungscode von 0 (Erfolg) hatte, wird dies auf -1 festgelegt.

HostObject

Optionaler ITaskHost-Parameter.

Gibt die Instanz des Hostobjekts an (kann NULL sein). Wenn die Host-IDE einem Hostobjekt diese spezielle Aufgabe zugeordnet hat, legt das Buildmodul diese Eigenschaft fest.

Log

Optionaler schreibgeschützter TaskLoggingHelper-Parameter.

Ruft eine Instanz einer TaskLoggingHelperExtension-Klasse ab, die Aufgabenprotokollierungsmethoden enthält.

LogStandardErrorAsError

Option bool-Parameter.

Wenn true, werden alle im Standardfehlerstream empfangenen Meldungen als Fehler protokolliert werden.

StandardErrorImportance

Optionaler String-Parameter.

Wichtigkeit, mit der Text aus dem Standardausgabestream protokolliert werden soll.

StandardOutputImportance

Optionaler String-Parameter.

Wichtigkeit, mit der Text aus dem Standardausgabestream protokolliert werden soll.

Timeout

Virtueller optionaler Int32-Parameter.

Gibt die Zeit in Millisekunden an, nach der die ausführbare Datei der Aufgabe beendet wird. Der Standardwert lautet Int.MaxValue. Dieser gibt an, dass kein Timeoutintervall festgelegt ist. Der Timeout wird in Millisekunden angegeben.

ToolExe

Virtueller optionaler string-Parameter.

Projekte können dies implementieren, um einen ToolName zu überschreiben. Aufgaben können dies zur Erhaltung von ToolName überschreiben.

ToolPath

Optionaler string-Parameter.

Gibt den Speicherort an, von dem die Aufgabe die zugrunde liegende ausführbare Datei lädt. Wird dieser Parameter nicht angegeben, verwendet die Aufgabe den SDK-Installationspfad für die Framework-Version, in der MSBuild ausgeführt wird.

UseCommandProcessor

Optionaler bool-Parameter.

Bei Festlegung auf true erstellt diese Aufgabe eine Batchdatei für die Befehlszeile und führt sie mithilfe des Befehlsprozessors anstelle der direkten Ausführung des Befehls direkt aus.

YieldDuringToolExecution

Optionaler bool-Parameter.

Bei Festlegung auf true gibt diese Aufgabe den Knoten zurück, wenn die Aufgabe ausgeführt wird.

Siehe auch

Konzepte

MSBuild-Aufgaben

Weitere Ressourcen

Referenz zu MSBuild-Aufgaben