crusade-tracker/system/caches/pluginsDslCache/doc/jetbrains.build-server.configs.kotlin.v10.build-steps/-visual-studio-step/index.html
2021-01-18 15:27:50 -05:00

240 lines
12 KiB
HTML

<HTML>
<HEAD>
<meta charset="UTF-8">
<title>VisualStudioStep - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v10.buildSteps</a>&nbsp;/&nbsp;<a href="./index.html">VisualStudioStep</a><br/>
<br/>
<h1>VisualStudioStep</h1>
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">VisualStudioStep</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/index.html"><span class="identifier">BuildStep</span></a></code>
<p>A <a href="https://confluence.jetbrains.com/pages/viewpage.action?pageId=74844955">build step</a> running Visual Studio solution.</p>
<p><strong>See Also</strong><br/>
<p><a href="../visual-studio.html">visualStudio</a></p>
</p>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-m-s-build-tools-version/index.html">MSBuildToolsVersion</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">MSBuildToolsVersion</span></code>
<p>MSBuild ToolsVersion</p>
</td>
</tr>
<tr>
<td>
<p><a href="-m-s-build-version/index.html">MSBuildVersion</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">MSBuildVersion</span></code>
<p>MSBuild version</p>
</td>
</tr>
<tr>
<td>
<p><a href="-platform/index.html">Platform</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">Platform</span></code>
<p>A required platform bitness</p>
</td>
</tr>
<tr>
<td>
<p><a href="-visual-studio-version/index.html">VisualStudioVersion</a></p>
</td>
<td>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">VisualStudioVersion</span></code>
<p>Microsoft Visual Studio version</p>
</td>
</tr>
</tbody>
</table>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="-init-.html">&lt;init&gt;</a></p>
</td>
<td>
<code><span class="identifier">VisualStudioStep</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.VisualStudioStep$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.VisualStudioStep, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildSteps.VisualStudioStep)/init">init</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">VisualStudioStep</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.buildSteps.VisualStudioStep$<init>(kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.buildSteps.VisualStudioStep, kotlin.Unit)), jetbrains.buildServer.configs.kotlin.v10.buildSteps.VisualStudioStep)/base">base</span><span class="symbol">:</span>&nbsp;<a href="./index.html"><span class="identifier">VisualStudioStep</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="args.html">args</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">args</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>Additional command line parameters for MSBuild</p>
</td>
</tr>
<tr>
<td>
<p><a href="configuration.html">configuration</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">configuration</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>Specify solution configuration for the build.</p>
</td>
</tr>
<tr>
<td>
<p><a href="ms-build-tools-version.html">msBuildToolsVersion</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">msBuildToolsVersion</span><span class="symbol">: </span><a href="-m-s-build-tools-version/index.html"><span class="identifier">MSBuildToolsVersion</span></a><span class="symbol">?</span></code>
<p>A version of tools to be used to compile (equivalent to the /toolsversion: commandline argument).</p>
</td>
</tr>
<tr>
<td>
<p><a href="ms-build-version.html">msBuildVersion</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">msBuildVersion</span><span class="symbol">: </span><a href="-m-s-build-version/index.html"><span class="identifier">MSBuildVersion</span></a><span class="symbol">?</span></code>
<p>MSBuild version to use</p>
</td>
</tr>
<tr>
<td>
<p><a href="path.html">path</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">path</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>A path to the solution to be built relative to the build <a href="https://www.jetbrains.com/help/teamcity/?Build+Checkout+Directory">checkout directory</a></p>
</td>
</tr>
<tr>
<td>
<p><a href="platform.html">platform</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">platform</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>Specify solution platform for the build.</p>
</td>
</tr>
<tr>
<td>
<p><a href="run-platform.html">runPlatform</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">runPlatform</span><span class="symbol">: </span><a href="-platform/index.html"><span class="identifier">Platform</span></a><span class="symbol">?</span></code>
<p>A required platform bitness</p>
</td>
</tr>
<tr>
<td>
<p><a href="targets.html">targets</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">targets</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>Specify list of MSBuild targets to execute.</p>
</td>
</tr>
<tr>
<td>
<p><a href="version.html">version</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">version</span><span class="symbol">: </span><a href="-visual-studio-version/index.html"><span class="identifier">VisualStudioVersion</span></a><span class="symbol">?</span></code>
<p>Visual Studio version to use</p>
</td>
</tr>
<tr>
<td>
<p><a href="working-dir.html">workingDir</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">workingDir</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p><a href="https://www.jetbrains.com/help/teamcity/?Build+Working+Directory">Build working directory</a> for ant script,
specify it if it is different from the <a href="https://www.jetbrains.com/help/teamcity/?Build+Checkout+Directory">checkout directory</a>.</p>
</td>
</tr>
</tbody>
</table>
<h3>Inherited Properties</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/conditions.html">conditions</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">conditions</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step-conditions/index.html"><span class="identifier">BuildStepConditions</span></a></code>
<p>Optional collection of build step execution conditions</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/enabled.html">enabled</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">enabled</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code>
<p>Specifies whether the step is enabled</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/execution-mode.html">executionMode</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">executionMode</span><span class="symbol">: </span><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/-execution-mode/index.html"><span class="identifier">ExecutionMode</span></a></code>
<p>Build step <a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/-execution-mode/index.html">execution mode</a></p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/id.html">id</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">id</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span></code>
<p>Id of the step, if not specified will be generated</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/name.html">name</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">name</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
<p>Build step name</p>
</td>
</tr>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/type.html">type</a></p>
</td>
<td>
<code><span class="keyword">var </span><span class="identifier">type</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a></code>
<p>Build step type</p>
</td>
</tr>
</tbody>
</table>
<h3>Inherited Functions</h3>
<table>
<tbody>
<tr>
<td>
<p><a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step/conditions.html">conditions</a></p>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">conditions</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.BuildStep$conditions(jetbrains.buildServer.configs.kotlin.v10.BuildStepConditions, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.BuildStepConditions, kotlin.Unit)))/base">base</span><span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step-conditions/index.html"><span class="identifier">BuildStepConditions</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v10.BuildStep$conditions(jetbrains.buildServer.configs.kotlin.v10.BuildStepConditions, kotlin.Function1((jetbrains.buildServer.configs.kotlin.v10.BuildStepConditions, kotlin.Unit)))/init">init</span><span class="symbol">:</span>&nbsp;<a href="../../jetbrains.build-server.configs.kotlin.v10/-build-step-conditions/index.html"><span class="identifier">BuildStepConditions</span></a><span class="symbol">.</span><span class="symbol">(</span><span class="symbol">)</span>&nbsp;<span class="symbol">-&gt;</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a>&nbsp;<span class="symbol">=</span>&nbsp;{}<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Configures <a href="https://www.jetbrains.com/help/teamcity/?Build+Step+Conditions">build step conditions</a></p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>