crusade-tracker/system/caches/pluginsDslCache/doc/jetbrains.build-server.configs.kotlin.v2019_2/-dsl-context/get-parameter.html
2021-01-18 15:27:50 -05:00

18 lines
1.8 KiB
HTML

<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DslContext.getParameter - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">jetbrains.buildServer.configs.kotlin.v2019_2</a>&nbsp;/&nbsp;<a href="index.html">DslContext</a>&nbsp;/&nbsp;<a href="./get-parameter.html">getParameter</a><br/>
<br/>
<h1>getParameter</h1>
<a name="jetbrains.buildServer.configs.kotlin.v2019_2.DslContext$getParameter(kotlin.String, kotlin.String)"></a>
<code><span class="keyword">fun </span><span class="identifier">getParameter</span><span class="symbol">(</span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2.DslContext$getParameter(kotlin.String, kotlin.String)/name">name</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="jetbrains.buildServer.configs.kotlin.v2019_2.DslContext$getParameter(kotlin.String, kotlin.String)/defaultValue">defaultValue</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</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>Returns the value of the context parameter specified in Versioned Settings UI.
If <a href="get-parameter.html#jetbrains.buildServer.configs.kotlin.v2019_2.DslContext$getParameter(kotlin.String, kotlin.String)/defaultValue">defaultValue</a> is null and the parameter is not defined, then DSL code will fail
and the corresponding error will be shown in the UI.</p>
</BODY>
</HTML>