<example> Element
Provides an example of usage for the job.
Syntax
<example>
Example text
</example>
Remarks
The <example> element is enclosed within the <runtime> element.
Legacy Code Example
The following script demonstrates the use of the <example> Element:
<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>
</job>
Everything between <example> and </example> tags gets picked up, including new lines and extra white space. Calling the ShowUsage method from this script results in the following output:
This script reboots a server
Usage: reboot.wsf /server:value
Options:
server : Server to run the script on
Example:
reboot.wsf /server:scripting