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 no EXT_COMMAND deve especificar que o tipo desse argumento é cadeia de caracteres.

[in] Required

Especifica se o argumento é necessário. Se Obrigatório for true e o argumento não estiver presente na linha de comando, ExtInvalidArgumentException será gerado. Você não precisa definir esse parâmetro; se não estiver definido Padrões obrigatórios como true.

Retornar valor

GetArgStr retorna o argumento de cadeia de caracteres nomeado.

Comentários

Para obter uma visão geral da análise de argumentos na estrutura de extensões 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
Plataforma de Destino Área de Trabalho
Cabeçalho engextcpp.hpp (inclua Engextcpp.hpp)

Confira também

EXT_COMMAND

ExtExtension