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

El método SetArgStr establece un argumento de cadena con nombre para el comando de expresión actual.

Sintaxis

bool SetArgStr(
  [in] PCSTR Name,
  [in] PCSTR Arg,
  [in] bool  OnlyIfUnset
);

Parámetros

[in] Name

Especifica el nombre del argumento. La descripción de la línea de comandos usada en EXT_COMMAND debe especificar que el tipo de este argumento es string.

[in] Arg

Cadena que especifica el valor del argumento con nombre. Un puntero al primer carácter que no es espacio se guarda como argumento. En este caso, de Arg no debe ser 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

setArgStr 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