ToolTaskExtension-Basisklasse

  • Artikel

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

Parameter

In der folgenden Tabelle werden die Parameter der Basisklassen beschrieben.

Parameter Beschreibung
BuildEngine Optionaler IBuildEngine-Parameter.

Gibt die für die Aufgaben verfügbare Build-Engine-Schnittstelle an. Die Build-Engine legt diesen Parameter automatisch fest, damit Aufgaben zurückgerufen werden können.
BuildEngine2 Optionaler IBuildEngine2-Parameter.

Gibt die für die Aufgaben verfügbare Build-Engine-Schnittstelle an. Die Build-Engine legt diesen Parameter automatisch fest, damit Aufgaben zurückgerufen werden können.

Hierbei handelt es sich um eine benutzerfreundliche Eigenschaft. Daher müssen die von dieser Klasse erbenden Aufgabenautoren den Wert nicht von IBuildEngine zu IBuildEngine2 umwandeln.
BuildEngine3 Optionaler IBuildEngine3-Parameter.

Gibt die durch den Host bereitgestellte Build-Engine-Schnittstelle an.
EchoOff Optionaler bool-Parameter.

Bei der Festlegung auf true gibt diese Aufgabe /Q an die Befehlszeile cmd.exe so weiter, dass die Befehlszeile nicht zu „stdout“ kopiert wird.
EnvironmentVariables Optionaler String-Arrayparameter.

Ein Array von Paaren von Umgebungsvariablen; durch Gleichheitszeichen getrennt. Diese Variablen werden an die erstellte ausführbare Datei zusätzlich zum regulären Umgebungsblock oder zum ausgewählten Überschreiben hinzugefügt.
ExitCode Optionaler schreibgeschützter Int32-Ausgabeparameter.

Gibt den durch den ausgeführten Befehl bereitgestellten Exitcode an. Wenn bei der Aufgabe Fehler protokolliert wurden, der Prozess jedoch über einen Exitcode von „0“ (Erfolg) verfügt hat, wird dies auf „-1“ festgelegt.
HostObject Optionaler ITaskHost-Parameter.

Gibt die Hostobjektinstanz (kann null sein) an. Die Build-Engine legt diese Eigenschaft fest, wenn die Host-IDE ein Hostobjekt mit dieser bestimmten Aufgabe verknüpft hat.
Log Optionaler schreibgeschützter TaskLoggingHelper-Parameter.

Ruft eine Instanz einer TaskLoggingHelperExtension-Klasse ab, die Aufgabenprotokollierungsmethoden enthält.
LogStandardErrorAsError Optionaler bool-Parameter.

Wenn true gegeben ist, werden alle im Standardfehlerstream empfangenen Meldungen als Fehler protokolliert.
StandardErrorImportance Optionaler String-Parameter.

Wichtigkeit, mit der Text aus dem Standardausgabestream protokolliert wird.
StandardOutputImportance Optionaler String-Parameter.

Wichtigkeit, mit der Text aus dem Standardausgabestream protokolliert wird.
Timeout Virtueller optionaler Int32-Parameter.

Gibt die Zeitdauer in Millisekunden an, nach der die ausführbare Datei der Aufgabe beendet wird. Der Standardwert ist Int.MaxValue. Dieser gibt an, dass es kein Zeitlimit gibt. Das Timeout in Millisekunden.
ToolExe Virtueller optionaler string-Parameter.

Projekte implementieren dies möglicherweise zum Überschreiben eines ToolName. Aufgaben überschreiben dies möglicherweise zum Beibehalten des ToolName.
ToolPath Optionaler string-Parameter.

Gibt den Speicherort an, von wo aus die Aufgabe die zugrunde liegende ausführbare Datei lädt. Wenn dieser Parameter nicht angegeben ist, verwendet die Aufgabe den SDK-Installationspfad der Version des Frameworks, die von MSBuild ausgeführt wird.
UseCommandProcessor Optionaler bool-Parameter.

Wenn die Festlegung auf true gegeben ist, erstellt diese Aufgabe eine Batchdatei für die Befehlszeile und führt sie aus, indem der Befehl nicht direkt ausgeführt wird, sondern der Befehlsprozessor verwendet wird.
YieldDuringToolExecution Optionaler bool-Parameter.

Bei der Festlegung auf true ergibt diese Aufgabe den Knoten, wenn dessen Aufgabe ausgeführt wird.

Weitere Informationen