Metodo ExtExtension::SetUnnamedArg (engextcpp.hpp)

Il metodo SetUnnamedArg imposta un argomento senza nome per il comando di estensione corrente.

Sintassi

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

Parametri

[in] Index

Specifica l'indice dell'argomento. Index deve essere compreso tra zero e il numero di argomenti senza nome, come specificato nella descrizione della riga di comando usata in EXT_COMMAND, meno uno (argomenti senza nome - 1).

[in, optional] StrArg

Stringa che specifica il valore dell'argomento senza nome.

Se l'argomento è di tipo stringa, come argomento viene salvato un puntatore al primo carattere non spazio. In questo caso, StrArg non deve essere NULL.

Se l'argomento è di tipo espressione, strArg viene valutato usando l'analizzatore di espressioni predefinito e il valore restituito dall'analizzatore di espressioni predefinito diventa il valore dell'argomento. In questo caso, StrArg può essere NULL e usare NumArg.

Se l'argomento è di tipo booleano, StrArg viene ignorato e può essere NULL.

[in] NumArg

Specifica il valore di un argomento di espressione senza nome. NumArg viene utilizzato solo se l'argomento è di tipo expression e strArg è NULL.

[in] OnlyIfUnset

Specifica cosa accade se l'argomento è già impostato. Se OnlyIfUnset è true e l'argomento è già stato impostato, l'argomento non verrà modificato. Se OnlyIfUnset è false e l'argomento è già stato impostato, l'argomento verrà modificato.

Valore restituito

SetUnnamedArg restituisce true se l'argomento è stato modificato; false in caso contrario.

Osservazioni

Per una panoramica dell'analisi degli argomenti nel framework delle estensioni EngExtCpp, vedere Parsing Extension Arguments.

Questo metodo deve essere chiamato solo durante l'esecuzione di un comando di estensione fornito da questa classe.

Fabbisogno

Requisito	Valore
piattaforma di destinazione	Desktop
intestazione	engextcpp.hpp (include Engextcpp.hpp)

Vedere anche

EXT_COMMAND

ExtExtension