ExtExtension::SetUnnamedArg-Methode (engextcpp.hpp)
Die SetUnnamedArg-Methode legt ein unbenannte Argument für den aktuellen Erweiterungsbefehl fest.
Syntax
bool SetUnnamedArg(
[in] ULONG Index,
[in, optional] PCSTR StrArg,
[in] ULONG64 NumArg,
[in] bool OnlyIfUnset
);
Parameter
[in] Index
Gibt den Index des Arguments an. Der Index sollte zwischen null und der Anzahl der unbenannten Argumente sein, wie in der Befehlszeilenbeschreibung in EXT_COMMAND angegeben, minus eins (unbenannte Argumente - 1).
[in, optional] StrArg
Eine Zeichenfolge, die den Wert des unbenannten Arguments angibt.
Wenn das Argument vom Typ string ist, wird ein Zeiger auf das erste Leerzeichen als Argument gespeichert. In diesem Fall darf StrArg nicht NULL sein.
Wenn das Argument vom Typ Expression ist, wird StrArg mithilfe der Standardausdrucksauswertung ausgewertet, und der vom Standardausdrucksauswerter zurückgegebene Wert wird zum Wert des Arguments. In diesem Fall kann StrArgNULL sein, und stattdessen sollte NumArg verwendet werden.
Wenn das Argument vom Typ Boolean ist, wird StrArg ignoriert und kann NULL sein.
[in] NumArg
Gibt den Wert eines unbenannten Ausdrucksarguments an. NumArg wird nur verwendet, wenn das Argument vom Typ Expression und StrArgnull ist.
[in] OnlyIfUnset
Gibt an, was geschieht, wenn das Argument bereits festgelegt ist. Wenn OnlyIfUnset ist true und das Argument bereits festgelegt wurde, wird das Argument nicht geändert. Wenn OnlyIfUnset ist false und das Argument bereits festgelegt wurde, wird das Argument geändert.
Rückgabewert
SetUnnamedArg gibt zurück true , wenn das Argument geändert wurde, andernfalls false .
Hinweise
Eine Übersicht über die Argumentanalyse im EngExtCpp-Erweiterungsframework finden Sie unter Analysieren von Erweiterungsargumenten.
Diese Methode sollte nur während der Ausführung eines Erweiterungsbefehls aufgerufen werden, der von dieser Klasse bereitgestellt wird.
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform | Desktop |
| Kopfzeile | engextcpp.hpp (include Engextcpp.hpp) |