Compartilhar via


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

O método SetArgStr define um argumento de cadeia de caracteres nomeado para o comando de expressão atual.

Sintaxe

bool SetArgStr(
  [in] PCSTR Name,
  [in] PCSTR Arg,
  [in] bool  OnlyIfUnset
);

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] Arg

Uma cadeia de caracteres que especifica o valor do argumento nomeado. Um ponteiro para o primeiro caractere sem espaço é salvo como o argumento . Nesse caso, Arg não deve ser NULL.

[in] OnlyIfUnset

Especifica o que acontece se o argumento já estiver definido. Se OnlyIfUnset for true e o argumento já tiver sido definido, o argumento não será alterado. Se OnlyIfUnset for false e o argumento já tiver sido definido, o argumento será alterado.

Retornar valor

SetArgStr retornará true se o argumento tiver sido alterado; caso contrário, false .

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.

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