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 não espacial é salvo como o argumento. Nesse caso, do Arg não deve ser NULL.

[in] OnlyIfUnset

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

Valor de retorno

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

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.

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