ExtExtension::SetArgStr メソッド (engextcpp.hpp)

SetArgStr メソッドは、現在の式コマンドの名前付き文字列引数を設定します。

構文

bool SetArgStr(
  [in] PCSTR Name,
  [in] PCSTR Arg,
  [in] bool  OnlyIfUnset
);

[in] Name

引数の名前を指定します。 EXT_COMMANDで使用されるコマンドラインの説明では、この引数の型が string であることを指定する必要があります。

[in] Arg

名前付き引数の値を指定する文字列。最初の空白以外の文字へのポインターが引数として保存されます。この場合、 Arg は NULL にすることはできません。

[in] OnlyIfUnset

引数が既に設定されている場合の動作を指定します。 OnlyIfUnset がでtrue、引数が既に設定されている場合、引数は変更されません。 OnlyIfUnset がでfalse、引数が既に設定されている場合、引数は変更されます。

引数が変更falseされた場合は SetArgStr が返されます。それ以外の場合はを返trueします。

EngExtCpp 拡張機能フレームワークでの引数の解析の概要については、「拡張引数の解析」を参照してください。

このメソッドは、このクラスによって提供される拡張コマンドの実行中にのみ呼び出す必要があります。

要件	値
対象プラットフォーム	デスクトップ
Header	engextcpp.hpp (Engextcpp.hpp を含む)