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

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

Синтаксис

PCSTR GetArgStr(
  [in] PCSTR Name,
  [in] bool  Required
);

Параметры

[in] Name

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

[in] Required

Указывает, является ли аргумент обязательным. Если обязательныйtrue и аргумент не был представлен в командной строке, вызывается extInvalidArgumentException. Не нужно задавать этот параметр; Значение , если параметр Обязательный по умолчанию не задан.

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

GetArgStr возвращает именованный строковый аргумент.

Замечания

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

Строка, возвращаемая GetArgStr, имеет смысл только во время выполнения текущей команды расширения.

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

Требования

См. также

EXT_COMMAND

ExtExtension