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