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 . Index debe estar entre cero y el número de argumentos sin nombre, tal 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 expresión, 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 se puede NULL y se debe usar NumArg en su lugar.

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

[in] NumArg

Especifica el valor de un argumento de expresión sin nombre. NumArg solo se usa si el argumento es de tipo expresión 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.

Observaciones

Para obtener información general sobre el análisis de argumentos en el marco de extensiones EngExtCpp, vea 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

Consulte también

EXT_COMMAND

extExtension