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

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

Sintaxis

bool SetUnnamedArgStr(
  [in] ULONG Index,
  [in] PCSTR Arg,
  [in] bool  OnlyIfUnset
);

Parámetros

[in] Index

Especifica el índice 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. Índice 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.

[in] Arg

Cadena que especifica el valor del argumento sin nombre. Un puntero al primer carácter que no es espacio se guarda como argumento.

[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

setUnnamedArgStr 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