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