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

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

構文

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

パラメーター

[in] Name

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

[in] Arg

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

[in] OnlyIfUnset

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

戻り値

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

備考

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

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

必要条件

関連項目

EXT_COMMAND

ExtExtension を する