ExtExtension::SetArgStr-Methode (engextcpp.hpp)
Die SetArgStr-Methode legt ein benanntes Zeichenfolgenargument für den aktuellen Ausdrucksbefehl fest.
Syntax
bool SetArgStr(
[in] PCSTR Name,
[in] PCSTR Arg,
[in] bool OnlyIfUnset
);
Parameter
[in] Name
Gibt den Namen des Arguments an. Die in EXT_COMMAND verwendete Befehlszeilenbeschreibung muss angeben, dass der Typ dieses Arguments Zeichenfolge ist.
[in] Arg
Eine Zeichenfolge, die den Wert des benannten Arguments angibt. Ein Zeiger auf das erste Leerzeichen wird als Argument gespeichert. In diesem Fall darf Arg nicht NULL sein.
[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
SetArgStr 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) |