ExtExtension::GetArgStr-Methode (engextcpp.hpp)
Die GetArgStr-Methode gibt ein benanntes Zeichenfolgenargument aus der Befehlszeile zurück, die zum Aufrufen des aktuellen Erweiterungsbefehls verwendet wird.
Syntax
PCSTR GetArgStr(
[in] PCSTR Name,
[in] bool Required
);
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] Required
Gibt an, ob das Argument erforderlich ist. Wenn Erforderlich ist true und das Argument nicht in der Befehlszeile vorhanden war, wird ExtInvalidArgumentException ausgelöst. Sie müssen diesen Parameter nicht festlegen. , wenn die Einstellung Erforderlich nicht auf festgelegt ist, wird standardmäßig auf truefestgelegt.
Rückgabewert
GetArgStr gibt das benannte Zeichenfolgenargument zurück.
Hinweise
Eine Übersicht über die Argumentanalyse im EngExtCpp-Erweiterungsframework finden Sie unter Analysieren von Erweiterungsargumenten.
Die von GetArgStr zurückgegebene Zeichenfolge ist nur während der Ausführung des aktuellen Erweiterungsbefehls sinnvoll.
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) |