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

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

Синтаксис

bool SetArg(
  [in]           PCSTR   Name,
  [in, optional] PCSTR   StrArg,
  [in]           ULONG64 NumArg,
  [in]           bool    OnlyIfUnset
);

Параметры

[in] Name

Указывает имя аргумента.

[in, optional] StrArg

Строка, указывающая значение именованного аргумента.

Если аргумент имеет тип строковую, в качестве аргумента сохраняется указатель на первый символ, отличный от пробела. В этом случае StrArg не должны быть NULL.

Если аргумент имеет тип выражения , StrArg вычисляется с помощью средства оценки выражений по умолчанию, а значение становится значением аргумента. В этом случае StrArg можно использовать null и вместо этого используется NumArg.

Если аргумент имеет тип логический, StrArg игнорируется и может быть NULL.

[in] NumArg

Задает значение именованного аргумента выражения. NumArg используется только в том случае, если тип аргумента является выражением и StrArgNULL.

[in] OnlyIfUnset

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

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

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

Замечания

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

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

Требования