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

Artigo
02/26/2024

O método SetArg define um argumento nomeado para o comando de extensão atual.

Sintaxe

bool SetArg(
  [in]           PCSTR   Name,
  [in, optional] PCSTR   StrArg,
  [in]           ULONG64 NumArg,
  [in]           bool    OnlyIfUnset
);

Parâmetros

[in] Name

Especifica o nome do argumento.

[in, optional] StrArg

Uma cadeia de caracteres que especifica o valor do argumento nomeado.

Se o argumento for do tipo cadeia de caracteres, um ponteiro para o primeiro caractere não espacial será salvo como o argumento . Nesse caso, StrArg não deve ser NULL.

Se o argumento for do tipo expressão, StrArg será avaliado usando o avaliador de expressão padrão e o valor se tornará o valor do argumento. Nesse caso, StrArg pode ser NULL e NumArg é usado.

Se o argumento for do tipo booliano, StrArg será ignorado e poderá ser NULL.

[in] NumArg

Especifica o valor de um argumento de expressão nomeada. NumArg só será usado se o tipo do argumento for uma expressão e StrArg for 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

SetArg 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)

Compartilhar via