ExtExtension::SetArg メソッド (engextcpp.hpp)
SetArg メソッドは、現在の拡張コマンドの名前付き引数を設定します。
構文
bool SetArg(
[in] PCSTR Name,
[in, optional] PCSTR StrArg,
[in] ULONG64 NumArg,
[in] bool OnlyIfUnset
);
パラメーター
[in] Name
引数の名前を指定します。
[in, optional] StrArg
名前付き引数の値を指定する文字列。
引数が文字列 型の場合、最初の空白以外の文字へのポインターが引数として保存されます。 この場合、StrArg を NULL することはできません。
引数が式 型の場合、StrArg は既定の式エバリュエーターを使用して評価され、値は引数の値になります。 この場合、StrArg は NULL でき、代わりに NumArg が使用されます。
引数がブール 型の場合、StrArg は無視され、NULL できます。
[in] NumArg
名前付き式引数の値を指定します。 NumArg は、引数の型が式であり、StrArg が NULL 場合にのみ使用されます。
[in] OnlyIfUnset
引数が既に設定されている場合の動作を指定します。
OnlyIfUnset が true
されていて、引数が既に設定されている場合、引数は変更されません。
OnlyIfUnset が false
され、引数が既に設定されている場合は、引数が変更されます。
戻り値
SetArg は、引数が変更された場合に true
を返します。それ以外 false
。
備考
EngExtCpp 拡張機能フレームワークでの引数の解析の概要については、「拡張引数の解析 を参照してください。
このメソッドは、このクラスによって提供される拡張コマンドの実行中にのみ呼び出す必要があります。
必要条件
要件 | 価値 |
---|---|
ターゲット プラットフォーム の | デスクトップ |
ヘッダー | engextcpp.hpp (Engextcpp.hpp を含む) |