对脚本的命名参数进行说明。

<named
   name = namedname
   helpstring = helpstring
   type = "string|boolean|simple"
   required = boolean
/>

参数

name

表示要说明的参数名的字符串。在命令行和脚本中定义参数。

helpstring

表示有关参数帮助说明的字符串。WSH 运行时使用 ShowUsage 方法或 /? 参数提供帮助说明。

type

可选。对参数的类型进行说明，参数的类型定义如何从命令行分析参数。默认值为 simple。

required

可选。指明某个参数是否必需的布尔值。只影响用法的显示。

说明

"<named>" 元素是用一对 runtime 标记括起来的。

名为 server 的参数在命令行提供一个 /server 参数，在 WSHNamed 参数集中提供名为 server 的参数。

如果类型为 string，则参数为字符串。该参数以 /named:stringvalue 的形式传递给脚本。

如果类型为 Boolean，则参数为布尔值。该参数以 /named+ 的形式传递给脚本以开启它，或者以 /named- 的形式传递给脚本以关闭它。

如果类型为 simple，则该参数不采用其他值，而只以名称 /named 的形式传递。

示例

下面的脚本将演示 <named> 元素的用法：

<job>
<runtime>
<named
name="server"
helpstring="Server to access"
type="string"
required="true"
  />
<named
name="user"
helpstring="User account to use on server.Default is current account."
type="string"
required="false"
  />
<named
name="enable"
helpstring="If true (+), enables the action.A minus(-) disables."
type="boolean"
required="true"
  />
<named
name="verbose"
helpstring="If specified, output will be verbose."
type="boolean"
required="false"
  />
</runtime>
<script language="JScript">
WScript.Arguments.ShowUsage();
</script>
</job>

This will produce the following output when usage is shown:

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

Options:

server    :Server to access
user      :User account to use on server.Default is current account.
enable    :If true (+), enables the action.A minus(-) disables.
verbose   :If specified, output will be verbose.

请参阅

ShowUsage 方法 | <runtime> 元素 | <unnamed> 元素 | <description> 元素 | <example> 元素