MSBuild プロパティ
プロパティはビルドを設定するための名前と値のペアです。プロパティを使用することで、タスクに値を渡したり、条件を評価したりできるだけでなく、プロジェクト ファイルで参照する値を格納しておくこともできます。
プロジェクト ファイルでのプロパティの定義と参照
プロパティを宣言するには、そのプロパティの名前を持つ要素を PropertyGroup 要素の子として作成します。たとえば、次の XML では、BuildDir という名前のプロパティを作成し、Build を値として設定しています。
<PropertyGroup>
<BuildDir>Build</BuildDir>
</PropertyGroup>
プロジェクト ファイルでプロパティを参照するには、$(PropertyName) という構文を使用します。たとえば、前の例に示したプロパティを参照するには、$(BuildDir) と記述します。
プロパティ値を変更するには、プロパティを再定義します。BuildDir プロパティに新しい値を設定するには、次の XML を使用します。
<PropertyGroup>
<BuildDir>Alternate</BuildDir>
</PropertyGroup>
プロパティは、プロジェクト ファイルに表示される順に評価されます。BuildDir の新しい値は、古い値が割り当てられた後で宣言する必要があります。
予約済みのプロパティ
MSBuild では、プロジェクト ファイルに関する情報や MSBuild のバイナリに関する情報を保持するために、いくつかのプロパティ名が予約されています。これらのプロパティは、他のプロパティと同じように $ 表記を使用して参照できます。たとえば、$(MSBuildProjectFile) は、ファイル名の拡張子を含むプロジェクト ファイルの完全なファイル名を返します。
詳細については、「方法 : プロジェクト ファイルの名前または場所を参照する」および「MSBuild 予約済みのプロパティ」を参照してください。
環境プロパティ
プロジェクト ファイルで環境変数を参照する場合も、予約済みのプロパティを参照するときと同じ方法を使用します。たとえば、プロジェクト ファイルで PATH 環境変数を使用するには、$(Path) と記述します。プロジェクト ファイルに、環境プロパティと同じ名前のプロパティが定義されている場合、環境変数の値はプロジェクト内のプロパティによってオーバーライドされます。
各MSBuildプロジェクトに分離環境ブロックがあります: これは、独自に記述ブロックだけを読み込みますいます。MSBuildは、プロジェクト ファイルが評価されるか、またはビルドする前にコレクション プロパティを初期化する場合にのみ環境変数を読み取ります。その後、環境の静的プロパティは、同じ名前と値を持つつまり、それぞれの子ツールの先頭になります。
内部取得するには、子のツールから環境変数の現在の値を、プロパティ関数 System.Environment.GetEnvironmentVariableを使用します。ただし、場合、タスク パラメーター EnvironmentVariablesを使用することです。この文字列配列に設定されている環境プロパティは、子のツールにシステム環境変数に影響を与えずに渡すことができます。
.gif "ヒント") ヒント |
|---|
最初のプロパティにするにすべての環境変数が読取られません。名前が「386 "などの、任意の有効なMSBuildプロパティ名、以外の環境変数でも、無視されます。 |
詳細については、「方法 : ビルドで環境変数を使用する」を参照してください。
レジストリのプロパティ
システム レジストリ値を読み取るには、次の構文を使用します。ここで、Hive はレジストリ ハイブ (たとえば、HKEY_LOCAL_MACHINE)、Key はキー名、SubKey はサブキー名、Value はサブキーの値をそれぞれ表します。
$(registry:Hive\MyKey\MySubKey@Value)
既定のサブキー値を取得するには、Value を省略します。
$(registry:Hive\MyKey\MySubKey)
このレジストリ値を使用して、ビルド プロパティを初期化できます。たとえば、Visual Studio の Web ブラウザーのホーム ページを表すビルド プロパティを作成するには、次のコードを使用します。
<PropertyGroup>
<VisualStudioWebBrowserHomePage>
$(registry:HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\11.0\WebBrowser@HomePage)
</VisualStudioWebBrowserHomePage>
<PropertyGroup>
グローバル プロパティ
MSBuild では、/property (または /p) スイッチを使用してコマンド ラインからプロパティを設定できます。これらのグローバル プロパティ値は、プロジェクト ファイルで設定されたプロパティ値をオーバーライドします。これには環境プロパティは含まれますが、予約済みのプロパティは含まれません。予約済みのプロパティは変更できません。
グローバルな Configuration プロパティを DEBUG に設定する例を次に示します。
msbuild.exe MyProj.proj /p:Configuration=DEBUG
グローバル プロパティは、MSBuild タスクの Properties 属性を使用することで、複数プロジェクトのビルドに含まれる子プロジェクトに対して設定または変更することもできます。詳細については、「MSBuild タスク」を参照してください。
プロジェクトのタグで TreatAsLocalProperty の属性を使用してプロパティを指定する場合、そのグローバル プロパティ値は、プロジェクト ファイルで設定されたプロパティ値をオーバーライドしません。詳細については、「Project 要素 (MSBuild)」および「方法 : 同じソース ファイルを異なるオプションでビルドする」を参照してください。
プロパティ関数
.NET Framework Version 4 以降では、プロパティ関数を使用して MSBuild スクリプトを評価できるようになりました。MSBuild タスクを使用しなくても、システム時刻の読み取り、文字列の比較、正規表現の照合、その他のさまざまな処理をビルド スクリプト内で実行できます。
文字列 (インスタンス) メソッドを使用してプロパティ値を操作したり、各種システム クラスの静的メソッドを呼び出したりできます。たとえば、ビルド プロパティを今日の日付に設定するには、次のようにします。
<Today>$([System.DateTime]::Now.ToString("yyyy.MM.dd"))</Today>
プロパティ関数の詳細と、プロパティ関数の一覧については、「プロパティ関数」を参照してください。
実行時のプロパティの作成
Target 要素の外側にあるプロパティには、ビルドの評価フェーズで値が割り当てられます。その後の実行フェーズでプロパティを作成または変更するには、次のようにします。
プロパティはどのタスクでも生成できます。プロパティを生成するには、Task 要素の子要素として、PropertyName 属性を持つ Output 要素を定義する必要があります。
プロパティは CreateProperty タスクによって生成できます。この使用法は推奨されていません。
.NET Framework 3.5 以降では、プロパティ宣言を格納できる PropertyGroup 要素を Target 要素に含めることができます。
プロパティに XML を格納する
プロパティには、タスクに値を渡したり、ログ情報を表示したりするための任意の XML を格納できます。次の例では、ConfigTemplate プロパティの値に、XML や他のプロパティ参照が使用されています。このプロパティ参照は、MSBuild により、対応するプロパティ値を使用して置き換えられます。プロパティ値は表示される順に割り当てられます。したがって、この例では、$(MySupportedVersion)、$(MyRequiredVersion)、および $(MySafeMode) は既に定義されています。
<PropertyGroup>
<ConfigTemplate>
<Configuration>
<Startup>
<SupportedRuntime
ImageVersion="$(MySupportedVersion)"
Version="$(MySupportedVersion)"/>
<RequiredRuntime
ImageVersion="$(MyRequiredVersion)
Version="$(MyRequiredVersion)"
SafeMode="$(MySafeMode)"/>
</Startup>
</Configuration>
</ConfigTemplate>
</PropertyGroup>
参照
処理手順
方法 : 同じソース ファイルを異なるオプションでビルドする