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

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

Синтаксис

bool SetUnnamedArg(
  [in]           ULONG   Index,
  [in, optional] PCSTR   StrArg,
  [in]           ULONG64 NumArg,
  [in]           bool    OnlyIfUnset
);

Параметры

[in] Index

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

[in, optional] StrArg

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

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

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

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

[in] NumArg

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

[in] OnlyIfUnset

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

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

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

Замечания

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

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

Требования

См. также

EXT_COMMAND

ExtExtension