ExtExtension::GetArgStr メソッド (engextcpp.hpp)
GetArgStr メソッドは、現在の拡張コマンドを呼び出すために使用されるコマンド ラインから名前付き文字列引数を返します。
構文
PCSTR GetArgStr(
[in] PCSTR Name,
[in] bool Required
);
パラメーター
[in] Name
引数の名前を指定します。 EXT_COMMANDで使用されるコマンド ラインの説明では、この引数の型が string であることを指定する必要があります。
[in] Required
引数が必要かどうかを指定します。 Required が でtrue
、引数がコマンド ラインに存在しなかった場合、ExtInvalidArgumentException がスローされます。 このパラメーターを設定する必要はありません。[ 必須] が設定されていない場合、既定値は に true
設定されます。
戻り値
GetArgStr は 、名前付き文字列引数を返します。
注釈
EngExtCpp 拡張機能フレームワークでの引数の解析の概要については、「 拡張引数の解析」を参照してください。
GetArgStr によって返される文字列は、現在の拡張機能コマンドの実行中にのみ意味があります。
このメソッドは、このクラスによって提供される拡張コマンドの実行中にのみ呼び出す必要があります。
要件
要件 | 値 |
---|---|
対象プラットフォーム | デスクトップ |
Header | engextcpp.hpp (Engextcpp.hpp を含む) |