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