ExtExtension::GetArgStr-Methode (engextcpp.hpp)

Die GetArgStr--Methode gibt ein benanntes Zeichenfolgenargument aus der Befehlszeile zurück, mit der der aktuelle Erweiterungsbefehl aufgerufen 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 Erforderlichertrue ist und das Argument nicht in der Befehlszeile vorhanden war, wird ExtInvalidArgumentEx ception ausgelöst. Sie müssen diesen Parameter nicht festlegen; wenn sie nicht Erforderlich standardmäßig auf truefestgelegt ist.

Rückgabewert

GetArgStr- gibt das benannte Zeichenfolgenargument zurück.

Bemerkungen

Eine Übersicht über die Argumentanalyse im EngExtCpp-Erweiterungsframework finden Sie unter Parsing Extension Arguments.

Die von GetArgStr zurückgegebene Zeichenfolge ist nur während der Ausführung des aktuellen Erweiterungsbefehls aussagekräftig.

Diese Methode sollte nur während der Ausführung eines Erweiterungsbefehls aufgerufen werden, der von dieser Klasse bereitgestellt wird.

Anforderungen

Siehe auch

EXT_COMMAND

ExtExtension-