Describe un argumento con nombre de la secuencia de comandos.

<named
   name = nombre
   helpstring = cadenaDeAyuda
   type = "string|boolean|simple"
   required = booleano
/>

Argumentos

name

Cadena que representa el nombre del argumento que se describe. Define el argumento en la línea de comandos y en la secuencia de comandos.

helpstring

Cadena que representa la descripción del argumento en la Ayuda. El motor de tiempo de ejecución de WSH muestra la descripción de ayuda mediante el método ShowUsage o el modificador /?.

type

Opcional. Describe el tipo de argumento, que define cómo se analizará el mismo desde la línea de comandos. El valor predeterminado es simple.

required

Opcional. Un valor de tipo booleano que indica si un argumento es necesario o no. Sólo afecta a la presentación de la lista de utilización.

Comentarios

El elemento <named> está contenido en (encerrado entre) un par de etiquetas runtime.

Si crea un argumento llamado servidor, existirá un modificador /servidor en la línea de comandos, así como un argumento llamado servidor en la colección de argumentos WSHNamed.

Si el tipo es string, el argumento es una cadena. El argumento se pasa a la secuencia de comandos como /named:valorcadena.

Si el tipo es Boolean, el argumento es de tipo booleano. El argumento se pasa a la secuencia de comandos como /named+ para activarlo o /named- para desactivarlo.

Si el tipo del argumento es simple, no admite valores adicionales y únicamente se pasa el nombre a la secuencia de comandos, /named.

Ejemplo

La siguiente secuencia de comandos muestra cómo se utiliza el elemento <named>:

<job>
<runtime>
  <named
    name="servidor"
    helpstring="Servidor al que desea obtener acceso"
    type="string"
    required="true"
  />
  <named
    name="usuario"
    helpstring="Cuenta de usuario en el servidor. La predeterminada es la actual."
    type="string"
    required="false"
  />
  <named
    name="habilitar"
    helpstring="Si es cierta (+), habilita la acción. El signo menos (-) la deshabilita."
    type="boolean"
    required="true"
  />
  <named
    name="detallado"
    helpstring="Si incluye este argumento los resultados aparecerán detallados."
    type="boolean"
    required="false"
  />
</runtime>
<script language="JScript">
  WScript.Arguments.ShowUsage();
</script>
</job> 

Esta secuencia de comandos generará el siguiente resultado cuando se muestre su utilización:

Utilización: example.wsf /servidor:valor [/usuario:valor] /habilitar[+|-] [/detallado]

Opciones:

servidor    : Servidor al que desea obtener acceso
usuario     : Cuenta de usuario en el servidor. La predeterminada es la actual.
habilitar   : Si es cierta (+), habilita la acción. El signo menos (-) la deshabilita.
detallado   : Si incluye este argumento los resultados aparecerán detallados.

Consulte también

Método ShowUsage | Elemento <runtime> | Elemento <unnamed> | Elemento <description> | Elemento <example>