Método ExtExtension::GetArgStr (engextcpp.hpp)
El método GetArgStr devuelve un argumento de cadena con nombre de la línea de comandos que se usa para invocar el comando de extensión actual.
Sintaxis
PCSTR GetArgStr(
[in] PCSTR Name,
[in] bool Required
);
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] Required
Especifica si se requiere el argumento . Si Required es true
y el argumento no estaba presente en la línea de comandos, se inicia ExtInvalidArgumentException . No es necesario establecer este parámetro; si no se establece El valor predeterminado obligatorio es true
.
Valor devuelto
GetArgStr devuelve el argumento de cadena con nombre.
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.
La cadena devuelta por GetArgStr solo es significativa durante la ejecución del comando de extensión actual.
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 (include Engextcpp.hpp) |