Metodo ExtExtension::SetArg (engextcpp.hpp)

2025-02-06

Il metodo SetArg imposta un argomento denominato per il comando di estensione corrente.

Sintassi

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

Parametri

[in] Name

Specifica il nome dell'argomento.

[in, optional] StrArg

Stringa che specifica il valore dell'argomento denominato.

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 diventa il valore dell'argomento. In questo caso, StrArg può essere NULL e NumArg.

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

[in] NumArg

Specifica il valore di un argomento espressione denominata. NumArg viene utilizzato solo se il tipo dell'argomento è un'espressione 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

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

Condividi tramite