Описание команд

 

Язык программирования, на котором пишутся сценарии инсталляций, содержит, к данной версии, 71 макрокоманду, описания которых и представлены в настоящем приложении.

 

1)      AssignPack(P1)

 

Описание команды:

Данная команда указывает на файловый архив RAR, который по команде DePack будет распакован во временную папку.

 

Описание параметров:

P1 – Имя архива RAR

 

Возвращаемые ошибки:

“0 53” – отсутствие файла P1

 

2)      CallProcedure(P1)

 

Описание команды:

      Данная команда передает управление процедуре с именем P1, после чего продолжает выполнять прерванный сценарий.

 

Описание параметров:

P1 – Имя процедуры

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

3)      CheckChoosing(P1;P2)

 

Описание команды:

Данная команда выдаёт значение TRUE, если номер указанного параметра отмечен(см. Choosing).

 

Описание параметров:

P1 – Конечная переменная

P2 – Номер проверяемого параметра

 

Возвращаемые ошибки:

“0 381” – при неверном указании индекса параметра

 

4)      CheckDir(P1;P2)

 

Описание команды:

      Данная команда помещает в указанную переменную имя подпапки с указанным номером в перечисляемом листе, заданном командой SetDir.

 

Описание параметров:

P1 – Индекс подпапки

P2 – Конечная переменная

Возвращаемые ошибки:

“0 13” – в случае отсутствия указанного индекс

“0 9” – в случае неверного указания индекса

 

5)      CheckFile(P1;P2)

 

Описание команды:

      Данная команда помещает в указанную переменную имя файла с указанным номером в перечисляемом листе, заданном командой SetDir.

 

Описание параметров:

P1 – Индекс файла

P2 – Конечная переменная

 

Возвращаемые ошибки:

“0 13” – в случае отсутствия указанного индекс

“0 9” – в случае неверного указания индекса

 

6)      Choosing(P1;P2;P3;P4;P5;…;Pn)

 

Описание команды:

      Создаёт окно, где пользователю предлагается галочками выбрать несколько вариантов из многих.

 

Описание параметров:

P1 – Заголовок

P2 – Количество параметров

P3 – Возможность выхода(0 – невозможно, 1 – возможно) из инсталляции на данном шаге(наличие “крестика” на окне). Данное правило справедливо для всех пунктов с таким названием, поэтому подробная информация далее не указывается.

P4…Pn – название варианта

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

7)      ChoosingFile(P1;P2;P3;P4;P5;P6)

 

Описание команды:

      Данная команда открывает окно(типа CommandDialog) для выбора файла пользователем.

 

Описание параметров:

      P1 – Конечная переменная

      P2 – Тип выбора файла(0 – сохранение,1 – открытие)

      P3 – Заголовок окна

      P4 – Расширение файла (н.р. “Txt”) – данное расширение присваивается файлу по умолчанию

      P5 – Маска файлов для показа (н.р. “*.Txt”)

      P6 – Возможность выхода

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

8)      ClearFolder(P1)

 

Описание команды:

            Удаление папки вместе со всеми подпапками и файлами. ПОЛЬЗУЙТЕСЬ ОЧЕНЬ ОСТОРОЖНО!

 

Описание параметров:

P1 – Имя папки

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

Примечание: Для данной команды требуется указывать ПОЛНЫЙ путь папки.

 

9)      Condition(P1;P2;P3;P4)

 

Описание команды:

      Данная команда производит сравнение двух выражений по указанному признаку и при истинности выражения исполняет указанную команду.

 

Описание параметров:

P1 – Указатель сравнения (;>;<;...)

P2 – Выражение 1

P3 – Выражение 2

P4 – Дальнейшая команда. Дальнейшая команда указывается тем же синтаксисом, в той же строчке, с одним отличием – вместо открывающей скобки используется точка с запятой (н. р. “Condition(=;#1#;#2#;AssignPack;file1.pak)”)

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

10)  CopyFile(P1;P2)

 

Описание команды:

      Данная команда копирует файл из одного места в другое.

 

Описание параметров:

P1 – Исходный файл

P2 – Конечный файл

 

Возвращаемые ошибки:

“0 53” – Нет исходного файла

“0 70” – Копирование файла в себя

“0 71” – Отсутствие диска

“0 76” – Копирование в несуществующую папку

 

Примечание: При совпадении имён файл заменяется без предупреждения!

 

11)  CreateDir(P1)

 

Описание команды:

      Создание папки с указанным именем.

Описание параметров:

P1 – Имя папки

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

Примечание: Данная команда может создавать папки с подпапками неограниченной вложенности.

 

12)  CreateGroupD(P1)

 

Описание команды:

      Данная команда создаёт папку на Рабочем столе.

 

Описание параметров:

P1 – Имя папки на Рабочем столе

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

Примечание: Данная команда может создавать папки с подпапками неограниченной вложенности.

 

13)  CreateGroupSM(P1)

 

Описание команды:

      Команда создаёт папку в Главном меню.

 

Описание параметров:

P1 – Имя папки

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

           

Примечания: Данная команда может создавать папки с подпапками неограниченной вложенности.

ВНИМАНИЕ!  Папки создаются в Главном меню, а не в меню Программы!

 

14)  CreateLinkD(P1;P2;P3;P4)

 

Описание команды:

      Команда создаёт ярлык на рабочем столе в указанной папке.

 

Описание параметров:

P1 – Имя папки на Рабочем столе

P2 – Имя ярлыка

P3 – Имя исполняемого по ярлыку файла

P4 – Передаваемые параметры

 

Возвращаемые ошибки:

“0 76” – Отсутствие указанной папки на Рабочем столе.

“2 126” – Неверный исполняемый файл

 

15)  CreateLinkSM(P1;P2;P3;P4;P5)

 

Описание команды:

      Создание ярлыка в Главном меню.

 

Описание параметров:

P1 – Имя группы

P2 – Имя ярлыка

P3 – Имя исполняемого файла

P4 – Передаваемые параметры

P5 – Параметр глобальности: 0 – ярлык создаётся в глобальном меню, 1 – в локальном (пользователя)

 

Возвращаемые ошибки:

“2 123” – Неверно указана группа

“2 126” – Неверно указан файл

 

Примечания: Команда CreateGroupSM создаёт папки всегда в локальном (пользователя) меню.

                        Имя группы указывать необходимо всегда! Для этого можно пользоваться зарезервированными переменными: $StartMenu$ - для создания ярлыка непосредственно в меню Пуск, или $Programs$ - для создания ярлыка в корне меню Программы. Если же требуется поместить ярлык в папке меню Программы, то имя группы должно принимать значение имени требуемой папки.

                       

16)  CreateRegKey(P1;P2)

 

Описание команды:

      Создание указанного раздела реестра.

 

Описание параметров:

P1 – Дескриптор ключа (можно указывать зарезервированные переменные: $HKeyClassesRoot$, $HKeyCurrentUser$, $HKeyLocalMachine$, $HKeyPerformanceData$, $HKeyUsers$, $HKeyCurrentConfig$, $HKeyDynData$)

P2 – Имя раздела

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

17)  Cycle(P1;P2;P3;P4)

 

Описание команды:

      Выполняет указанную процедуру в цикле с шагом 1

 

Описание параметров:

P1 – Начальное значение

P2 – Конечное значение

P3 – Переменная цикла

P4 – Исполняемая в цикле процедура

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

18)  DeleteGroupD(P1)

 

Описание команды:

      Удаляет указанную папку с Рабочего стола.

 

Описание параметров:

P1 – Имя папки

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

Примечание: Папка удаляется вместе с подпапками и файлами.

 

19)  DeleteGroupSM(P1)

 

Описание команды:

      Удаляет папку из Главного меню

 

Описание параметров:

P1 – Имя папки

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

Примечания: Удаление папки только из меню пользователя.

                        Удаление вместе со всеми подпапками и ярлыками.

           

20)  DeleteLinkD(P1;P2)

 

Описание команды:

      Удаление ярлыка с рабочего стола.

 

Описание параметров:

P1 – Имя папки на Рабочем столе

P2 – Имя ярлыка

 

Возвращаемые ошибки:

“0 53” – при удалении несуществующего ярлыка.

 

21)  DeleteLinkSM(P1;P2)

 

Описание команды:

      Данная команда удаляет ярлык из главного меню.

 

Описание параметров:

P1 – Имя папки

P2 – Имя ярлыка

 

Возвращаемые ошибки:

“2 2” – такого ярлыка уже не существует.

 

Примечания: Удаление производится как из локальной, так и из глобальной группы.

      Также необходимо пользоваться правилами, описанными в примечаниях к команде CreateLinkSM.

 

22)  DeleteRegKey(P1;P2)

 

Описание команды:

      Данная команда удаляет указанный раздел реестра.

 

Описание параметров:

P1 – Дескриптор ключа

P2 – Имя раздела

 

Возвращаемые ошибки:

“2 121” – раздел уже удалён

           

23)  DePack()

 

Описание команды:

      Распаковка архива, указанного в команде AssignPack, во временную папку.

 

24)  End()

 

Описание команды:

      Завершает работу инсталлятора.

 

25)  FindWindow(P1;P2)

 

Описание команды:

      Ищет окно с заданным заголовком и выдаёт его хэндл.

 

Описание параметров:

P1 – Заголовок окна

P2 – Конечная переменная

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

26)  GenerateUninstallation(P1)

 

Описание команды:

      Создаёт деинсталляционную программу, помещает её в папку Windows, регистрирует в меню установки и удаления – даёт возможность пользователю деинсталлировать программу.

 

Описание параметров:

P1 – Название, под которым будет проходить деинсталляция.

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

Примечание: для выполнения этой операции необходима процедура Uninstallation, которая выполняет всю деинсталляцию продукта.

 

27)  GetDate(P1)

 

Описание команды:

      Выдаёт текущую системную дату.

 

Описание параметров:

P1 – Конечная переменная

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

28)  GetDiskFreeSpace(P1;P2)

 

Описание команды:

      Выдаёт свободное место на диске в мегабайтах.

 

Описание параметров:

P1 – Имя диска

P2 – Конечная переменная

 

Возвращаемые ошибки:

“0 68” – Нет диска

 

29)  GetFileLength(P1;P2)

 

Описание команды:

      Выдаёт длину файла в байтах.

 

Описание параметров:

P1 – Имя файла

P2 – Конечная переменная

 

Возвращаемые ошибки:

“0 53” – Отсутствие файла

“0 76” – Отсутствие указанного пути

“0 5” – Отсутствие диска

 

30)  GetTime(P1)

 

Описание команды:

      Возвращает системное время.

 

Описание параметров:

P1 – Конечная переменная

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

31)  GetUserName(P1)

 

Описание команды:

      Возвращает имя текущего пользователя.

 

Описание параметров:

P1 – Конечная переменная

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

32)  GetWindowsInfo(P1;P2;P3)

 

Описание команды:

      Данная команда возвращает информацию о текущей операционной системе.

 

Описание параметров:

P1 – Номер версии системы (Учтите! Информация выдаётся вида “5 1”, вместо “5.1”

P2 – Номер сборки системы

P3 – Номер платформы(1 – 9x, 2 – NT)

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

33)  GoToPoint(P1)

 

Описание команды:

      Переводит выполнение команды к строке с меткой, определяемой командой Point

 

Описание параметров:

P1 – Имя метки перехода.

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

Примечание: Имя метки перехода не должно повторяться в сценарии, однако вызвать метку из другой процедуры запрещено.

 

34)  GoToString(P1)

 

Описание команды:

      Данная команда переводит выполнение программы на строку с указанным порядковым номером.

 

Описание параметров:

P1 – номер строки перехода

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

35)  HideBackground()

 

Описание команды:

      Данная команда закрывает окно заднего фона.

 

36)  HideProgress()

 

Описание команды:

Данная команда закрывает окно прогресса.

 

37)  HideWelcome

 

Описание команды:

      Данная команда закрывает окно приветствия.

 

38)  Information(P1;P2;P3;P4;P5;P6)

 

Описание команды:

      Выводит на экран окно типа MessageBox и помещает ответ пользователя в указанную переменную.

 

Описание параметров:

P1 – Количество кнопок (1-3)

P2 – Сообщение на кнопке 1

P3 – Сообщение на кнопке 2

P4 – Сообщение на кнопке 3

P5 – Текст сообщения

P6 – Конечная переменная

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

Примечание: В конечную переменную помещается номер нажатой кнопки. Кнопки располагаются следующим образом (справа налево): 2-1-3

 

39)  InputString(P1;P2;P3)

 

Описание команды:

      Выводит окно с текстом и полем для ввода текста пользователем. Аналог InputBox.

 

Описание параметров:

P1 – Конечная переменная

P2 – Заголовок

P3 – Текст

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

40)  KillDir(P1)

 

Описание команды:

      Упрощённая команда ClearFolder. Удаляет только указанную папку без подпапок и файлов.

 

Описание параметров:

P1 – Имя папки

 

Возвращаемые ошибки:

“0 76” – Отсутствие удаляемой папки

“0 75” – Отсутствие диска

 

41)  KillFile(P1)

 

Описание команды:

      Данная команда удаляет указанный файл.

 

Описание параметров:

P1 – Имя удаляемого файла

 

Возвращаемые ошибки:

“0 53” – Отсутствие удаляемого файла.

 

42)  KillStringOfFile(P1;P2)

 

Описание команды:

      Удаление из файла строчки с указанным номером.

 

Описание параметров:

P1 – Имя файла

P2 – Индекс строки

 

Возвращаемые ошибки:

“0 53” – Отсутствие искомого файла.

 

Примечание: Если указанный индекс строки не соответствует числу строк файла, то файл остаётся без изменений.

 

 

43)  KillUninstallation(P1)

 

Описание команды:

      Выполняет действия, противоположные действиям GenerateInstallation.

 

Передаваемые параметры:

P1 – Название соответствующеё деинсталляции

 

Возвращаемые ошибки:

“1 0” – Такой деинсталляции нет.

 

44)  Let(P1;P2)

 

Описание команды:

      Данная команда присваивает указанной переменной указанное значение.

 

Описание параметров:

P1 – Конечная переменная

P2 – Указанное значение

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

45)  Mathematics(P1;P2;P3;P4)

 

Описание команды:

      Данная команда выполняет математические операции над десятичными числами.

 

Описание параметров:

P1 – Математические символы(+,-,/,*,^,^^,Sin,Cos)

P2 – Конечная переменная

P3 – Число 1

P4 – Число 2

 

Возвращаемые ошибки:

“0 11” – Деление на 0.

“0 6” – Переполнение.

 

46)  Mid(P1;P2;P3;P4)

 

Описание команды:

      Данная команда извлекает из исходной строки отрезок с заданными концами.

 

Описание параметров:

P1 – Конечная переменная

P2 – Исходная строка

P3 – Номер начального символа

P4 – Длина отрезка

 

Возвращаемые ошибки:

“0 5” – неверные значения строк начала и длины.

 

47)  Picture(P1)

 

Описание команды:

      В верхнем левом углу выводит указанную картинку.

 

Описание параметров:

P1 – Имя файла картинки

 

Возвращаемые ошибки:

“0 53” – Отсутствие файла.

“0 481” – неизвестный формат файла.

“0 76” – Отсутствие пути к файлу.

“0 71” – Отсутствие диска.

 

48)  Point(P1)

 

Описание команды:

            Данная команда определяет метку перехода по оператору GoToPoint.

 

Описание параметров:

P1 – Имя метки перехода.

 

Возвращаемые ошибки:

Данная команда не возвращает ошибок.

 

49)  ReadRegKeyValue(P1;P2;P3;P4)

 

Описание команды:

      Данная команда считывает указанное значение параметра подключа реестра.

 

Описание параметров:

P1 – Дескриптор ключа

P2 – Имя раздела

P3 – Имя параметра

P4 – Конечная переменная

 

Возвращаемые ошибки:

“2 2” – отсутствие указанного параметра

“2 6” – отсутствие указанного раздела

 

 

50)  ReadStringFromFile(P1;P2;P3)

 

Описание команды:

      Данная команда читает из файла строчку с указанным именем.

 

Описание параметров:

P1 – Имя файла

P2 – Номер строчки

P3 – Конечная переменная

 

Возвращаемые ошибки:

“0 62” – указан недопустимый номер строчки

“0 52” – указана ошибочная папка

 

51)  RegisterDll(P1)

 

Описание команды:

      Данная команда регистрирует ActiveX с указанным именем файла.

 

Описание параметров:

P1 – Имя файла

 

Возвращаемые ошибки:

“1 126” – не найден файл для регистрации

 

52)  Rem(P1)

 

Описание команды:

      Невыполняемый комментарий.

 

Описание параметров:

P1 – Комментарий

 

53)  RenameFile(P1;P2)

 

Описание команды:

      Данная команда переименовывает файл P1 в файл P2.

 

Описание параметров:

P1 – Файл 1

P2 – Файл 2

 

Возвращаемые ошибки:

“0 53” – Операция не выполнена.

 

54)  ResetChoosing()

 

Описание команды:

      Данная команда обнуляет список меню, выведенный командой Choosing.

 

Примечание: Данную команду необходимо выполнять каждый раз, когда вызывается команда Choosing.

 

55)  RestartSystem(P1)

 

Описание команды:

      Данная команда выводит окно с предложением перезагрузки компьютера.

 

Описание параметров:

P1 – Вид перезагрузки(0 – смена пользователя, 1 – завершение работы, 2 – перезагрузка, 4 – срочное завершение процессов).

 

Возвращаемые ошибки:

“2 25” – Пользователем отклонена перезагрузка.

 

56)  RunExe(P1;P2)

 

Описание команды:

      Данная команда запускает указанный исполняемый файл и в случае необходимости ждёт её завершения.

 

Описание параметров:

P1 – Имя файла

P2 – Тип запуска (Если требуется ждать завершения, то TRUE)

 

Возвращаемые ошибки:

“0 53”” – невозможно запустить файл.

 

57)  RunFile(P1)

 

Описание команды:

      В данной версии – аналог RunExe с параметром запуска False.

58)  SendMessage(P1;P2;P3;P4)

 

Описание команды:

      Посылка сообщения указанному окну.

 

Описание параметров:

P1 – Хэндл окна

P2 – Передаваемая команда

P3 – Параметр1

P4 – Параметр 2

 

Возвращаемые ошибки:

“2 1400” – сообщение не передано.

 

Примечание: передаваемые параметры и команды см. в документации к Windows.

 

59)  SetBackGround(P1;P2;P3;P4;P6;P7)

 

Описание команды:

      Установка заднего переливающегося фона с заголовком инсталляции.

 

Описание параметров:

P1 – Начальный цвет R

P2 – Конечный цвет R

P3 – Начальный цвет G

P4 – Конечный цвет G

P5 – Начальный цвет B

P6 – Конечный цвет B

P7 – Заголовок окна

 

Возвращаемые ошибки:

“0 5” – при неверных значениях цветов.

 

Примечание: цвет – от 0(черный) до 255(светлый).

 

60)  SetDir(P1;P2;P3)

 

Описание команды:

      Данная команда устанавливает фокус на указанной папке и возвращает число подпапок и файлов в ней.

 

Описание параметров:

P1 – Имя папки

P2 – Число подпапок

P3 – Число файлов

 

Возвращаемые ошибки:

“0 68” – отсутствие диска

“0 76” – отсутствие папки

 

61)  SetProgress(P1;P2;P3)

 

Описание команды:

      Данная команда устанавливает параметры окна прогресса.

 

Описание параметров:

P1 – Заголовок

P2 – Название операции

P3 – Количество выполненных процентов.

 

Возвращаемые ошибки:

“0 380” – неверно заданы выполненные проценты.

 

62)  SetValueReg(P1;P2;P3;P4)

 

Описание команды:

      Данная команда устанавливает значение параметра раздела реестра.

 

Описание параметров:

P1 – Дескриптор ключа.

P2 – Имя раздела

P3 – Имя параметра

P4 – Устанавливаемое значение

 

Возвращаемые ошибки:

“2 6” – неверный раздел.

 

63)  ShowBackground()

 

Описание команды:

      Данная команда выводит на экран окно, созданное командой SetBackground.

 

64)  ShowProgress()

 

Описание команды:

      Данная команда выводит на экран окно, созданное командой SetProgress.

 

65)  ShowReadme(P1)

 

Данная команда выводит на экран окно с текстом, прочитанным из указанного файла.

 

Описание параметров:

P1 – Имя файла с текстом

 

Возвращаемые ошибки:

“0 53” – Отсутствие указанного файла.

“0 5” – Отсутствие диска.

 

Примечание: Даже в случае ошибки окно выводится. Пустое.

 

66)  Stop()

 

Описание команды:

      Отладочная команда. При выполнении сценария в FI Manager, прерывает выполнение, открывает окно трассировки. При выполнении непосредственно в FI Executer, игнорируется.

 

67)  StringSummator(P1;P2;P3)

 

Описание команды:

      Данная команда возвращает сумму двух строк.

 

Описание параметров:

P1 – Конечная переменная

P2 – Строка 1

P3 – Строка 2

 

Возвращаемые ошибки:

Ошибки не возвращаются.

 

68)  WriteToEndOfFile(P1;P2)

 

Описание команды:

      Данная команда помещает указанную строчку в конец файла.

 

Описание параметров:

P1 – Имя файла

P2 – Строка

 

Возвращаемые ошибки:

“0 52” – невозможность создать файл.

 

Примечание: Если файл не существовал, то он создаётся.

 

69)  WriteToNewFile(P1;P2)

 

Описание команды:

      Создание нового файла и помещение в него указанной строки.

 

Описание параметров:

P1 – Имя файла

P2 – Строка

 

Возвращаемые ошибки:

“0 52” – невозможность создать файл.

 

70)  WriteToStringOfFile(P1;P2;P3)

 

Описание команды:

      Записывает в файл строку в указанное место(номер строки).

 

Описание параметров:

P1 – Имя файла

P2 – Номер строки

P3 – Строка

Возвращаемые ошибки:

“0 52” – невозможно найти файл.

 

71)  A