Compartir a través de


Método ExtExtension::SetUnnamedArg (engextcpp.hpp)

El método SetUnnamedArg establece un argumento sin nombre para el comando de extensión actual.

Sintaxis

bool SetUnnamedArg(
  [in]           ULONG   Index,
  [in, optional] PCSTR   StrArg,
  [in]           ULONG64 NumArg,
  [in]           bool    OnlyIfUnset
);

Parámetros

[in] Index

Especifica el índice del argumento . El índice debe estar entre cero y el número de argumentos sin nombre, como se especifica en la descripción de la línea de comandos usada en EXT_COMMAND, menos uno (argumentos sin nombre - 1).

[in, optional] StrArg

Cadena que especifica el valor del argumento sin nombre.

Si el argumento es de tipo cadena, se guarda un puntero al primer carácter que no es espacio como argumento. En este caso, StrArg no debe ser NULL.

Si el argumento es de tipo expression, StrArg se evalúa mediante el evaluador de expresiones predeterminado y el valor devuelto por el evaluador de expresiones predeterminado se convierte en el valor del argumento . En este caso, StrArg puede ser NULL y NumArg debe usarse en su lugar.

Si el argumento es de tipo Boolean, se omite StrArg y puede ser NULL.

[in] NumArg

Especifica el valor de un argumento de expresión sin nombre. NumArg solo se usa si el argumento es de tipo expression y StrArg es NULL.

[in] OnlyIfUnset

Especifica lo que sucede si el argumento ya está establecido. Si OnlyIfUnset es true y el argumento ya se ha establecido, el argumento no se cambiará. Si OnlyIfUnset es false y el argumento ya se ha establecido, se cambiará el argumento .

Valor devuelto

SetUnnamedArg devuelve true si se cambió el argumento; false de lo contrario, .

Comentarios

Para obtener información general sobre el análisis de argumentos en el marco de extensiones EngExtCpp, consulte Análisis de argumentos de extensión.

Solo se debe llamar a este método durante la ejecución de un comando de extensión proporcionado por esta clase.

Requisitos

Requisito Value
Plataforma de destino Escritorio
Encabezado engextcpp.hpp (incluya Engextcpp.hpp)

Consulte también

EXT_COMMAND

ExtExtension