通过

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

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

返回值

如果参数已更改，则 SetArgStr 返回 true ;false否则返回 。

注解

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

只能在执行此类提供的扩展命令期间调用此方法。

要求

要求 值
目标平台 桌面
标头 engextcpp.hpp (包括 Engextcpp.hpp)

另请参阅

EXT_COMMAND

ExtExtension