<unnamed> 要素

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

<unnamed
   name       = 名前なし引数名
   helpstring = ヘルプ文字列
   many       = ブール型の値
   required   = ブール型の値または整数値
/>

引数

  • name
    Usage (使用法) でこの引数を表すために使用する文字列です。この値は、ほかの用途には使用されません。
  • helpstring
    引数のヘルプ説明文を表す文字列です。WSH ランタイムでは、ShowUsage メソッドまたは /? 引数を使用してヘルプ説明文を表示できます。
  • many
    これは省略可能です。ブール型の値です。true に設定すると、required 属性で指定されている回数を超えて、この引数を繰り返すことが可能になります。true に設定しなければ、引数の必要数は、required 属性で指定したとおりの数になります。詳細については、下の例を参照してください。
  • required
    これは省略可能です。この引数をコマンド ライン上で繰り返す回数を示す整数値です。

解説

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

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

メモ   unnamed 要素の name 属性は、表示目的でのみ使用されます。

"required" 属性を設定すると、ブール型の値は整数に変換されます。"true" は 1 に、"false" は0 になります。

使用例

ここでは、いくつかの例を通して、各種属性が unnamed 要素の Usage (使用法) にどのように反映されるかを示します。まず、単純な例を示します。

<runtime>
<unnamed
  name="filename"
  helpstring="処理するファイル"
  many="false"
  required="true"
</>
</runtime>

この場合、次のような結果が得られます。

Usage: example.wsf filename

Options:

filename : 処理するファイル

上の例を下のように変更したとします。

<runtime>
<unnamed
  name="filename"
  helpstring="処理するファイル (複数)"
  many="false"
  required="3"
</ >
</runtime>

この場合、出力内容は次のように変化します。

Usage: example.wsf filename1 filename2 filename3

Options:

filename : 処理するファイル (複数)

many スイッチを使うと、示されているより多くのファイルを指定できる場合に省略記号が表示されるようになります。上の例を次のように変更したとします。

<runtime>
<unnamed
  name="filename"
  helpstring="処理するファイル (複数可)"
  many="true"
  required="1"
</>
</runtime>

この場合、出力内容は次のように変化します。

Usage: example.wsf filename1 [filename2...]

Options:

filename: 処理するファイル (複数可)

参照

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