Метод 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