<runtime> 要素

スクリプトが受け取る複数の実行時引数をグループ化します。

<runtime>
    <named 属性などの記述 />
    <unnamed 属性などの記述 />
    <example>Example Text</example>
    ...
</runtime>

解説

<runtime> 要素で囲まれた情報は、ShowUsage メソッドでスクリプトの実行時パラメータを表示するときに使用されます。

<runtime> 要素は、1 組の job タグで囲まれているので、定義した実行時引数はそのジョブにのみ適用されます。

メモ   WSH 5.6 では、<runtime> で囲まれたデータを自己文書化と ShowUsage で表示するデータの書式設定にのみ使用します。<runtime> 要素に含まれている引数に設定されている値は、強制適用されません。つまり、指定された引数がコマンド ラインから欠落していてもエラーになりません。<runtime> が .wsf ファイルに含まれている場合は、"/?" 引数付きでスクリプトを実行すると、Usage (使用法) が表示され、その時点でスクリプトが終了します。

使用例

ここでは、<runtime> 要素を使ったスクリプトのサンプルを示します。

<job>
    <runtime>
        <named
            name="server"
            helpstring="スクリプトを実行するサーバー"
            type="string"
            required="true"
        />
    </runtime>
<script language="JScript">
  if (!WScript.Arguments.Named.Exists("server"))
  {
    WScript.Arguments.ShowUsage();
  }
// ... ここにスクリプトを記述します。
</script>
</job>

参照

ShowUsage メソッド | <named> 要素 | <unnamed> 要素 | <description> 要素 | <example> 要素