ExtExtension::SetUnnamedArgStr 方法 (engextcpp.hpp)

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 且已设置参数,则将更改参数。

返回值

如果参数已更改,SetUnnamedArgStrtrue返回 ;false否则返回 。

注解

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

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

要求

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

另请参阅

EXT_COMMAND

ExtExtension