SetUnnamedArg 方法设置当前扩展命令的未命名参数。
语法
bool SetUnnamedArg(
[in] ULONG Index,
[in, optional] PCSTR StrArg,
[in] ULONG64 NumArg,
[in] bool OnlyIfUnset
);
参数
[in] Index
指定参数的索引。 索引 应介于零和未命名参数的数目之间,如在 EXT_COMMAND中使用的命令行说明中指定的,减去一个(未命名的参数 - 1)。
[in, optional] StrArg
一个字符串,指定未命名参数的值。
如果参数的类型 字符串,则指向第一个非空格字符的指针将保存为参数。 在这种情况下,StrArg 不得 NULL。
如果参数的类型 表达式,则使用默认表达式计算器计算 strArg ,默认表达式计算器返回的值将成为参数的值。 在这种情况下,StrArg 可以 NULL,应改用 NumArg。
如果参数的类型 布尔,则忽略 StrArg,并且可以 NULL。
[in] NumArg
指定未命名表达式参数的值。 仅当参数的类型为 表达式且 strArg 为 NULL NULL时,才使用 NumArg。
[in] OnlyIfUnset
指定如果参数已设置,会发生什么情况。 如果 OnlyIfUnsettrue
且参数已设置,则参数将不会更改。 如果 OnlyIfUnsetfalse
且参数已设置,则参数将更改。
返回值
SetUnnamedArg 在参数更改时返回 true
;否则 false
。
言论
有关 EngExtCpp 扩展框架中的参数分析的概述,请参阅 分析扩展参数。
只有在执行此类提供的扩展命令时,才应调用此方法。
要求
要求 | 价值 |
---|---|
目标平台 | 桌面 |
标头 | engextcpp.hpp (包括 Engextcpp.hpp) |