When 要素 (MSBuild)

  • [アーティクル]

Choose 要素で選ぶ対象のコード ブロックを指定します。

<Project><Choose><When><Choose> ... <Otherwise><Choose> ...

構文

<When Condition="'StringA'=='StringB'">
    <PropertyGroup>... </PropertyGroup>
    <ItemGroup>... </ItemGroup>
    <Choose>... </Choose>
</When>

属性と要素

以降のセクションでは、属性、子要素、および親要素について説明します。

属性

属性 説明
条件 必須の属性です。

評価する条件です。 詳細については、「条件」を参照してください。

子要素

要素 説明
Choose 省略可能な要素です。

子要素を評価して、実行するコードのセクションを 1 つ選びます。 Choose 要素に 0 個以上の When 要素があります。
ItemGroup 省略可能な要素です。

ユーザー定義 Item 要素のセットが含まれます。 ItemGroup 要素に 0 個以上の When 要素があります。
PropertyGroup 省略可能な要素です。

ユーザー定義の Property 要素のセットを格納します。 PropertyGroup 要素に 0 個以上の When 要素があります。

親要素

要素 説明
Choose 要素 (MSBuild) 子要素を評価して、実行するコードのセクションを 1 つ選びます。

解説

Condition 属性が true と評価された場合、その When 要素の子の ItemGroup 要素と PropertyGroup 要素が実行されて、後続の When 要素はすべてスキップされます。

Choose、When、Otherwise 要素を組み合わせて使って、実行される可能性のある複数のコード セクションから 1 つを選びます。 詳細については、「条件構造」を参照してください。

例

次のプロジェクトでは、Choose 要素を使って、設定する When 要素のプロパティ値のセットを選んでいます。 両方の When 要素の Condition 属性が false と評価された場合、Otherwise 要素のプロパティ値が設定されます。 この例を実行するときは、コマンド ラインからさまざまなプロパティ設定を渡してみて (msbuild myproj.proj -p:Configuration=Test;Platform=x86 など)、出力パスがどのようになるか確認してください。 この例で想定されている要件は、デバッグ ビルドとリリース ビルド用に特定のプロパティを設定することと (実際のプラットフォーム名ではなく、プラットフォームのビット数に基づく出力フォルダーなど)、"Test" と "Retail" の構成をサポートし、ただし "Retail" を "Release" として扱うことです。

<Project>
    <PropertyGroup>
       <Configuration Condition="$(Configuration) == ''">Debug</Configuration>
       <Platform Condition="$(Platform) == ''">x64</Platform>
    </PropertyGroup>

  <Choose>
     <When Condition="$(Configuration)=='Test'">
        <PropertyGroup>
            <DebugSymbols>true</DebugSymbols>
            <DebugType>full</DebugType>
            <Optimize>false</Optimize>
            <DefineConstants>DEBUG;TRACE</DefineConstants>
        </PropertyGroup>
        <Choose>
          <When Condition="$(Platform)=='x86' Or $(Platform) == 'ARM32'">
            <PropertyGroup>
                <OutputPath>.\bin\Test\32-bit\</OutputPath>
            </PropertyGroup>
          </When>
          <When Condition="$(Platform)=='x64' Or $(Platform) == 'ARM64'">
            <PropertyGroup>
                <OutputPath>.\bin\Test\64-bit\</OutputPath>
            </PropertyGroup>
          </When>
          <!-- For any other platform, use the platform name -->
          <Otherwise>
            <PropertyGroup>
              <OutputPath>.\bin\Test\$(Platform)\</OutputPath>
            </PropertyGroup>
          </Otherwise>
        </Choose>
      </When>
      <When Condition="$(Configuration)=='Retail' Or $(Configuration)=='Release'">
        <PropertyGroup>
            <DebugSymbols>false</DebugSymbols>
            <Optimize>true</Optimize>
            <DefineConstants>TRACE</DefineConstants>
        </PropertyGroup>
        <Choose>
          <When Condition="$(Platform)=='x86' Or $(Platform) == 'ARM32'">
             <PropertyGroup>
                <OutputPath>.\bin\Release\32-bit\</OutputPath>
             </PropertyGroup>
          </When>
          <When Condition="$(Platform)=='x64' Or $(Platform) == 'ARM64'">
             <PropertyGroup>
                <OutputPath>.\bin\Release\64-bit\</OutputPath>
             </PropertyGroup>
          </When>
          <!-- For any other platform, use the platform name -->
          <Otherwise>
            <PropertyGroup>
                <OutputPath>.\bin\Release\$(Platform)\</OutputPath>
            </PropertyGroup>
          </Otherwise>
        </Choose>
      </When>
      <!-- For any other configuration, use debug properties-->
      <Otherwise>
        <PropertyGroup>
            <DebugSymbols>true</DebugSymbols>
            <DebugType>full</DebugType>
            <Optimize>false</Optimize>
            <DefineConstants>DEBUG;TRACE</DefineConstants>
        </PropertyGroup>
        <Choose>
          <When Condition="$(Platform)=='x86' Or $(Platform)=='ARM32'">
            <PropertyGroup>
              <OutputPath>.\bin\$(Configuration)\32-bit\</OutputPath>
            </PropertyGroup>
          </When>
          <When Condition="$(Platform)=='x64' Or $(Platform)=='ARM64'">
            <PropertyGroup>
              <OutputPath>.\bin\$(Configuration)\64-bit\</OutputPath>
            </PropertyGroup>
          </When>
        </Choose>
       </Otherwise>
  </Choose>

  <Target Name="ShowProperties">
    <Message Text="DebugSymbols: $(DebugSymbols)"/>
    <Message Text="Optimize: $(Optimize)"/>
    <Message Text="DefineConstants: $(DefineConstants)"/>
    <Message Text="OutputPath: $(OutputPath)"/>
  </Target>
</Project>

関連項目