Gewusst wie: Verwenden von Buildereignissen in MSBuild-Projekten

Ein Buildereignis ist ein Befehl, der von MSBuild in einer bestimmten Phase des Buildprozesses ausgeführt wird. Das Präbuildereignis tritt auf, bevor der Build startet, das Prälinkereignis tritt auf, bevor der Linkschritt startet, und das Postbuildereignis tritt nach der erfolgreichen Beendigung des Builds auf. Ein Buildereignis tritt nur auf, wenn der zugeordnete Buildschritt auftritt. Das Prälinkereignis tritt z. B. nicht auf, wenn der Verknüpfungsschritt nicht ausgeführt wird.

Jedes der drei Buildereignisse wird in einer Elementdefinitionsgruppe durch folgende Elemente dargestellt: durch ein Befehlselement (<Command>), das ausgeführt wird, und durch ein Meldungselement, das angezeigt wird, (<Message>) wenn das Buildereignis von MSBuild ausgeführt wird. Jedes Element ist optional, und wenn Sie das gleiche Element mehrfach angeben, erhält das letzte Vorkommen Vorrang.

Ein optionales Element vom Typ In Buildvorgang verwenden (<Buildereignis UseInBuild>) kann in einer Eigenschaftengruppe angegeben werden, um anzugeben, ob das Buildereignis ausgeführt wird. Der Wert des Inhalts eines Elements vom Typ In Buildvorgang verwenden ist entweder true oder false. Standardmäßig wird ein Buildereignis ausgeführt, sofern das entsprechende Element vom Typ In Buildvorgang verwenden nicht auf false festgelegt wird.

In der folgenden Tabelle wird jedes XML-Element für Buildereignisse aufgeführt:

In der folgenden Tabelle ist jedes Element vom Typ In Buildvorgang verwenden aufgeführt:

Beispiel

Das folgende Beispiel kann innerhalb des Projektelements der in Exemplarische Vorgehensweise: Verwenden von MSBuild zum Erstellen eines Visual C++-Projekts erstellten Datei "myproject.vcxproj" hinzugefügt werden. In einem Präbuildereignis wird eine Kopie von "main.cpp" erstellt; in einem Prälinkereignis wird eine Kopie von "main.obj" erstellt; und in einem Postbuildereignis wird eine Kopie von "myproject.exe" erstellt. Wenn das Projekt mit einer Releasekonfiguration erstellt wird, werden die Buildereignisse ausgeführt. Wenn das Projekt mit einer Debugkonfiguration erstellt wird, werden die Buildereignisse nicht ausgeführt.

  <ItemDefinitionGroup>
    <PreBuildEvent>
      <Command>copy $(ProjectDir)main.cpp $(ProjectDir)copyOfMain.cpp</Command>
      <Message>Making a copy of main.cpp </Message>
    </PreBuildEvent>
    <PreLinkEvent>
   <Command>copy $(ProjectDir)$(Configuration)\main.obj $(ProjectDir)$(Configuration)\copyOfMain.obj</Command>
      <Message>Making a copy of main.obj</Message>
    </PreLinkEvent>
    <PostBuildEvent>
   <Command>copy $(ProjectDir)$(Configuration)\$(TargetFileName) $(ProjectDir)$(Configuration)\copyOfMyproject.exe</Command>
      <Message>Making a copy of myproject.exe</Message>
    </PostBuildEvent>
  </ItemDefinitionGroup>
 
  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
    <PreBuildEventUseInBuild>true</PreBuildEventUseInBuild>
    <PreLinkEventUseInBuild>true</PreLinkEventUseInBuild>
    <PostBuildEventUseInBuild>true</PostBuildEventUseInBuild>
  </PropertyGroup>

  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
    <PreBuildEventUseInBuild>false</PreBuildEventUseInBuild>
    <PreLinkEventUseInBuild>false</PreLinkEventUseInBuild>
    <PostBuildEventUseInBuild>false</PostBuildEventUseInBuild>
  </PropertyGroup>

Siehe auch

Aufgaben

Exemplarische Vorgehensweise: Verwenden von MSBuild zum Erstellen eines Visual C++-Projekts

Weitere Ressourcen

MSBuild (Visual C++)