ExtExtension::SetUnnamedArgStr-Methode (engextcpp.hpp)
Die SetUnnamedArgStr-Methode legt ein unbenannte Zeichenfolgenargument für den aktuellen Erweiterungsbefehl fest.
Syntax
bool SetUnnamedArgStr(
[in] ULONG Index,
[in] PCSTR Arg,
[in] bool OnlyIfUnset
);
Parameter
[in] Index
Gibt den Index des Arguments an. Die in EXT_COMMAND verwendete Befehlszeilenbeschreibung muss angeben, dass der Typ dieses Arguments Zeichenfolge ist. Der Index sollte zwischen 0 (null) und der Anzahl der unbenannten Argumente (wie in der in EXT_COMMAND verwendeten Befehlszeilenbeschreibung angegeben) minus eins sein.
[in] Arg
Eine Zeichenfolge, die den Wert des unbenannten Arguments angibt. Ein Zeiger auf das erste Leerzeichen wird als Argument gespeichert.
[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
SetUnnamedArgStr 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) |