<named> 要素

スクリプトの名前付き引数を記述します。

<named
   name = 名前付き引数名
   helpstring = ヘルプ文字列
   type = "string|boolean|simple"
   required = ブール型の値
/>

引数

• name
  記述する引数の名前を表す文字列です。コマンド ラインとスクリプトで使用する引数を定義します。
• helpstring
  引数のヘルプ説明文を表す文字列です。WSH ランタイムでは、ShowUsage メソッドまたは /? 引数を使用してヘルプ説明文を表示できます。
• type
  これは省略可能です。引数の種類を指定します。これにより、引数をコマンド ラインから解釈する方法が決まります。既定値は、simple です。
• required
  これは省略可能です。引数が必須かどうかを示すブール型の値です。Usage (使用法) の表示にのみ反映されます。

解説

<named> 要素は、1 組の runtime タグ内に含まれます。

たとえば、server という名前の引数を定義すると、コマンド ライン引数として /server が追加され、同時に、server という名前の引数が WSHNamed 引数コレクションに追加されます。

type として string を指定すると、引数は文字列になります。引数は、/named:stringvalue としてスクリプトに渡されます。

type として Boolean を指定すると、引数はブール型になります。引数をオンにするには /named+ としてスクリプトに渡し、オフにするには /named- として渡します。

type として simple を指定すると、引数は付加的な値をとらなくなり、指定した名前 (/named) のまま渡されます。

使用例

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

<job>
<runtime>
  <named
    name="server"
    helpstring="アクセスするサーバー"
    type="string"
    required="true"
  />
  <named
    name="user"
    helpstring="サーバーで使用するユーザー アカウント。既定は現在のアカウントです。"
    type="string"
    required="false"
  />
  <named
    name="enable"
    helpstring="true (+) で動作を有効にします。マイナス (-) で無効にします。"
    type="boolean"
    required="true"
  />
  <named
    name="verbose"
    helpstring="これを設定すると、出力が詳細モードになります。"
    type="boolean"
    required="false"
  />
</runtime>
<script language="JScript">
  WScript.Arguments.ShowUsage();
</script>
</job>

このスクリプトで Usage (使用法) が表示されるとき、次の出力が伴います。

Usage: example.wsf /server:value [/user:value] /enable[+|-] [/verbose]

Options:

server    : アクセスするサーバー
user      : サーバーで使用するユーザー アカウント。既定は現在のアカウントです。
enable    : true (+) で動作を有効にします。マイナス (-) で無効にします。
verbose   : これを設定すると、出力が詳細モードになります。

参照

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