ExtExtension：：SetArgStr 方法（engextcpp.hpp）

SetArgStr 方法为当前表达式命令设置命名字符串参数。

语法

bool SetArgStr(
  [in] PCSTR Name,
  [in] PCSTR Arg,
  [in] bool  OnlyIfUnset
);

参数

[in] Name

指定参数的名称。 EXT_COMMAND 中使用的命令行说明必须指定此参数的类型为字符串。

[in] Arg

一个字符串，指定命名参数的值。 指向第一个非空格字符的指针将保存为参数。 在这种情况下，Arg 不得 NULL。

[in] OnlyIfUnset

指定如果参数已设置，会发生什么情况。 如果 OnlyIfUnsettrue 且参数已设置，则参数将不会更改。 如果 OnlyIfUnsetfalse 且参数已设置，则参数将更改。

返回值

SetArgStr 在参数更改时返回 true;否则 false。

言论

有关 EngExtCpp 扩展框架中的参数分析的概述，请参阅 分析扩展参数。

只有在执行此类提供的扩展命令时，才应调用此方法。

要求

另请参阅

EXT_COMMAND

ExtExtension