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 对象