ShowUsage メソッド

スクリプトの使用方法に関する情報を表示してスクリプト自身の説明をします。

object.ShowUsage

引数

• object
  WScript オブジェクトです。

解説

ShowUsage メソッドを呼び出すと、"使用法" と呼ばれるヘルプ画面が表示され、スクリプトのコマンド ライン オプションの詳細情報が表示されます。この情報は、*.WSF ファイルのランタイム セクションに基づいて作成されます。<runtime> タグと </runtime> タグの間に記述されたすべての情報が組み合わされて "使用法ステートメント" と呼ばれるものが作成されます。この使用法ステートメントを使って、ユーザーにスクリプトの使い方を伝えることができます。

メモ   使用法は、/? スイッチを使って表示することもできます。

使用例

次のサンプル コードは、*.WSF スクリプト ファイル内に使用法の情報をセットアップする例です。

<job>
    <runtime>
        <description>This script reboots a server</description>
        <named
            name = "Server"
            helpstring = "Server to run the script on"
            type = "string"
            required = "true"
        />
        <example>Example: reboot.wsf /server:scripting</example>
    </runtime>
<script language="VBScript">

If WScript.Arguments.Count <> 1 Then
   WScript.Arguments.ShowUsage
   WScript.Quit
End If

</script>
</job>

JScript の対応するコード ブロックは次のとおりです。

if (WScript.Arguments.length != 1)
{
   WScript.Arguments.ShowUsage();
   WScript.Quit();
}

このスクリプト内から ShowUsage メソッドを呼び出すと、次の出力結果が得られます。

This script reboots a server
Usage: reboot.wsf /server:value

Options:
server : Server to run the script on

Example:
reboot.wsf /server:scripting

参照

WScript オブジェクト