Compartilhar via


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

O método SetUnnamedArg define um argumento sem nome para o comando de extensão atual.

Sintaxe

bool SetUnnamedArg(
  [in]           ULONG   Index,
  [in, optional] PCSTR   StrArg,
  [in]           ULONG64 NumArg,
  [in]           bool    OnlyIfUnset
);

Parâmetros

[in] Index

Especifica o índice do argumento . O índice deve estar entre zero e o número de argumentos não nomeados, conforme especificado na descrição da linha de comando usada em EXT_COMMAND, menos um (argumentos não nomeados – 1).

[in, optional] StrArg

Uma cadeia de caracteres que especifica o valor do argumento sem nome.

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 de expressão de tipo, StrArg será avaliado usando o avaliador de expressão padrão e o valor retornado pelo avaliador de expressão padrão se tornará o valor do argumento. Nesse caso, StrArg pode ser NULL e NumArg deve ser usado.

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

[in] NumArg

Especifica o valor de um argumento de expressão sem nome. NumArg só será usado se o argumento for de expressão de tipo 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

SetUnnamedArg 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