ExtExtension::SetUnnamedArgStr-Methode (engextcpp.hpp)
Die SetUnnamedArgStr--Methode legt ein nicht benanntes 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. Index- sollte zwischen Null und der Anzahl der nicht benannten Argumente ( wie in der in EXT_COMMAND verwendeten Befehlszeilenbeschreibung - minus 1 angegeben sein.
[in] Arg
Eine Zeichenfolge, die den Wert des nicht benannten Arguments angibt. Ein Zeiger auf das erste Nicht-Leerzeichen wird als Argument gespeichert.
[in] OnlyIfUnset
Gibt an, was passiert, wenn das Argument bereits festgelegt ist. Wenn OnlyIfUnset-true ist und das Argument bereits festgelegt wurde, wird das Argument nicht geändert. Wenn OnlyIfUnset-false ist und das Argument bereits festgelegt wurde, wird das Argument geändert.
Rückgabewert
SetUnnamedArgStr- gibt true zurück, wenn das Argument geändert wurde; andernfalls false.
Bemerkungen
Eine Übersicht über die Argumentanalyse im EngExtCpp-Erweiterungsframework finden Sie unter Parsing Extension Arguments.
Diese Methode sollte nur während der Ausführung eines Erweiterungsbefehls aufgerufen werden, der von dieser Klasse bereitgestellt wird.
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform- | Desktop |
| Header- | engextcpp.hpp (include Engextcpp.hpp) |