Приложения

Приложение А. Функции, константы и структуры RDS

А.5. Сервисные функции и макросы RDS

А.5.2. Управление работой RDS и функции общего назначения

А.5.2.23. rdsGetCmdParam – параметр командной строки по номеру

Функция rdsFindCmdParam возвращает указатель на параметр (слово) с заданным номером в командной строке RDS.

  RDSCSTR RDSCALL rdsGetCmdParamA( // UTF8
    int Num,       // Номер слова
    BOOL UpperCase // Вернуть в верхнем регистре
  );
  RDSWCSTR RDSCALL rdsGetCmdParamW( // UTF16
    int Num,       // Номер слова
    BOOL UpperCase // Вернуть в верхнем регистре
  );
  // Функция-псевдоним
  RDSXCSTR RDSCALL rdsGetCmdParam( // Кодировка по умолчанию
    int Num,       // Номер слова
    BOOL UpperCase // Вернуть в верхнем регистре
  );

Тип указателя на эту функцию

RDS_SIB (для UTF8) или RDS_WsIB (для UTF16)

Параметры

Num (int)

Номер слова в командной строке. Нумерация начинается с нуля. Общее число слов можно получить вызовом rdsGetCmdParamCount.

UpperCase (BOOL)

TRUE, если необходимо вернуть слово, все символы которого переведены в верхний регистр, и FALSE, если слово нужно в том регистре, в котором оно было введено.

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

Указатель на строку во внутренней памяти RDS, содержащую запрошенное слово в нужном регистре, или NULL, если слово с таким номером отсутствует. Вызвавшая функция не должна изменять эту строку.

Примечания

Функция rdsGetCmdParam работает с параметрами командной строки, использовавшейся для запуска RDS с одновременной загрузкой схемы, или со списком параметров, переданных в сервисную функцию rdsExecuteCommand для выполнения команд загрузки схемы RDS_SYSCMD_LOADFILE и RDS_SYSCMD_LOADTEMPLATE. Если схема загружена из пользовательского интерфейса RDS (например, при помощи пункта меню «файл | загрузить»), список параметров будет пустым.

Одним параметром командной строки считается либо слово, отделенное от остальных слов командной строки пробелами, либо текст, заключенный в двойные кавычки. В список, доступный сервисным функциям, попадают только параметры командной строки, не разобранные RDS. Например, слово «/run», указывающее RDS, что в загруженной схеме необходимо немедленно запустить расчет, в этот список не попадет, так же как и само имя файла загружаемой схемы.

См. также

Сервисные функции со строковыми параметрами и результатом, rdsGetCmdParamCount, rdsFindCmdParam, параметры командной строки RDS.