Compartilhar via


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

O método GetArgStr retorna um argumento de cadeia de caracteres nomeado da linha de comando usada para invocar o comando de extensão atual.

Sintaxe

PCSTR GetArgStr(
  [in] PCSTR Name,
  [in] bool  Required
);

Parâmetros

[in] Name

Especifica o nome do argumento. A descrição da linha de comando usada em EXT_COMMAND deve especificar que o tipo desse argumento é cadeia de caracteres.

[in] Required

Especifica se o argumento é necessário. Se Obrigatório estiver true e o argumento não estiver presente na linha de comando, ExtInvalidArgumentException será gerada. Você não precisa definir esse parâmetro; se ele não estiver definido o padrão de obrigatório será true.

Valor de retorno

GetArgStr retorna o argumento de cadeia de caracteres nomeado.

Observações

Para obter uma visão geral da análise de argumentos na estrutura de extensões do EngExtCpp, consulte analisando argumentos de extensão.

A cadeia de caracteres retornada por GetArgStr só é significativa durante a execução do comando de extensão atual.

Esse método só deve ser chamado durante a execução de um comando de extensão fornecido por essa classe.

Requisitos

Requisito Valor
da Plataforma de Destino Área de trabalho
cabeçalho engextcpp.hpp (inclua Engextcpp.hpp)

Consulte também

EXT_COMMAND

extExtension