Muestra la información necesaria acerca de la utilización de una secuencia de comandos.

objeto.ShowUsage

Parámetros

objeto

Objeto WScript.

Comentarios

Al ejecutar el método ShowUsage se muestra una pantalla de Ayuda (a la que se denomina de utilización) en la que se muestran los detalles acerca de las opciones de línea de comandos de la secuencia de comandos. Esta información se obtiene de la sección runtime del archivo *.WSF. Todo el texto que se incluye entre las etiquetas <runtime> y </runtime> se une para generar lo que se conoce como "declaración de utilización". Esta declaración indica al usuario cómo se utiliza la secuencia de comandos.

Nota   La información de utilización también aparece si se utiliza el modificador /?.

Ejemplo

El siguiente ejemplo muestra cómo configurar la información de utilización en un archivo de comandos *.WSF.

<job>
    <runtime>
        <description>Esta secuencia de comandos reinicia un servidor</description>
        <named
            name = "Servidor"
            helpstring = "Servidor en el que se ejecuta la secuencia de comandos"
            type = "string"
            required = "true"
        />
        <example>Ejemplo: reboot.wsf /Servidor:secuencia de comandos</example>
    </runtime>
<script language="VBScript">

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

</script>
</job>

The JScript code for the equivalent script block would be:

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

Al llamar al método ShowUsage desde esta secuencia de comandos se obtiene el siguiente resultado:

Esta secuencia de comandos reinicia el servidor
Utilización: reboot.wsf /servidor:valor

Opciones:

servidor : Servidor en el que se ejecuta la secuencia de comandos
Ejemplo:
reboot.wsf /servidor:secuencia de comandos

Consulte también

Objeto WScript