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

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

Sintaxis

bool SetArg(
  [in]           PCSTR   Name,
  [in, optional] PCSTR   StrArg,
  [in]           ULONG64 NumArg,
  [in]           bool    OnlyIfUnset
);

Parámetros

[in] Name

Especifica el nombre del argumento.

[in, optional] StrArg

Cadena que especifica el valor del argumento con 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 se convierte en el valor del argumento. En este caso, StrArg se puede NULL y se usa 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 con nombre. NumArg solo se usa si el tipo del argumento es una 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

setArg 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