Метод ExtExtension::SetUnnamedArgStr (engextcpp.hpp)

Метод SetUnnamedArgStr задает неименованный строковый аргумент для текущей команды расширения.

Синтаксис

bool SetUnnamedArgStr(
  [in] ULONG Index,
  [in] PCSTR Arg,
  [in] bool  OnlyIfUnset
);

Параметры

[in] Index

Указывает индекс аргумента. Описание командной строки, используемое в EXT_COMMAND, должно указывать, что тип этого аргумента является строкой. индекс должен находиться в диапазоне от нуля до числа неименованных аргументов, как указано в описании командной строки, используемом в EXT_COMMAND – минус один.

[in] Arg

Строка, указывающая значение неназванного аргумента. Указатель на первый символ, отличный от пробела, сохраняется в качестве аргумента.

[in] OnlyIfUnset

Указывает, что происходит, если аргумент уже задан. Если OnlyIfUnsettrue и аргумент уже задан, аргумент не будет изменен. Если OnlyIfUnsetfalse и аргумент уже задан, аргумент будет изменен.

Возвращаемое значение

SetUnnamedArgStr возвращает true, если аргумент был изменен; false в противном случае.

Замечания

Общие сведения о синтаксическом анализе аргументов в платформе расширений EngExtCpp см. в .

Этот метод должен вызываться только во время выполнения команды расширения, предоставленной этим классом.

Требования

Требование	Ценность
целевая платформа	Настольный
заголовка	engextcpp.hpp (include Engextcpp.hpp)

См. также

EXT_COMMAND

ExtExtension