Поделиться через


VSZ-файл (элемент управления проекта)

Отправной точкой любого мастера является VSZ-файл. VSZ-файл представляет собой текстовый файл, определяющий мастер, который требуется вызвать, и передаваемые этому мастеру данные. Файл содержит двухстрочный заголовок, за которым следуют различные необязательные параметры, которые должны быть переданы мастеру. Список необязательных параметром см. в разделе Предопределенные символы специального мастера.

В следующем примере показан заголовок VSZ-файла.

VSWIZARD 7.0
Wizard=VsWizard.VsWizardEngine.10.0
Param="WIZARD_NAME = My AppWizard"
  • Первая строка заголовка указывает номер версии формата файла шаблона. Можно задать следующие числа: 6.0, 7.0 или 7.1. Другие числа не допускаются, и их использование приведет к возникновению ошибки "Недопустимый формат".

  • Вторая строка присваивает для переменной Wizard идентификатор ProgID мастера, созданного средой Visual Studio. Идентификатор ProgID является строковым представлением идентификатора CLSID, например VsWizard.VsWizardEngine.10.0.

    Если в мастере имеется пользовательский интерфейс, идентификатор ProgID автоматически указывает мастеру на необходимость реализации интерфейса IVCWizCtlUI. По умолчанию методы данного интерфейса используются в HTM-файлах проекта. Можно изменить поведение мастера посредством использования методов для этого интерфейса в HTM-файлах. Дополнительные сведения см. в описании класса VCWizCtl, который является компонентным классом для интерфейса IVCWizCtlUI.

  • За двумя первыми строками следует необязательный список параметров, который позволяет VSZ-файлу передавать дополнительные настраиваемые параметры в мастер. Каждое значение передается мастеру как строковый элемент в массиве значений типа Variant в методе Execute элемента управления. По умолчанию мастер с пользовательским интерфейсом производит следующие параметры по умолчанию:

    Param="START_PATH = <path to the wizard>"
    Param="HTML_PATH = <path to the wizard's HTML file>"
    Param="TEMPLATES_PATH = <path to the wizard's template file>"
    Param="SCRIPT_PATH = <path to the wizard's script files>"
    Param="IMAGES_PATH = <path to the wizard's images>"
    

    Если мастер не имеет пользовательского интерфейса, он не имеет также параметра IMAGES_PATH и вместо него содержит следующие параметры:

    Param="WIZARD_UI = FALSE"
    Param="SOURCE_FILTER = txt"
    
  • VSZ-файл может содержать следующие параметры, которые указывают функции, находящиеся в файле Common.js:

    Param="PREPROCESS_FUNCTION = CanAddATLClass"
    Param="PREPROCESS_FUNCTION = CanAddMFCClass"
    Param="PREPROCESS_FUNCTION = CanAddClass"
    

ФункцииCanAddATLClass, CanAddMFCClass и CanAddClass вызываются мастером для подтверждения доступности Модели кода Visual C++. Если одна функция возвращает значение false, мастер не запускается.

Можно добавить мастер на панель шаблонов в диалоговом окне Новый проект в Visual Studio, поместив файл VSZ в каталог "vcprojects". По умолчанию, специальный мастер записывает VSZ-файл в этот каталог.

Примечание

Если удалить файлы и каталоги мастера, следует также удалить файлы проекта с расширением VSZ, VSDIR и ICO из каталога "vcprojects".

См. также

Задачи

Создание пользовательского мастера

Ссылки

Специальный мастер

Основные понятия

Файлы, создаваемые для мастера

Добавление мастеров в диалоговые окна "Добавить элемент" и "Создать проект" при помощи файлов VSDIR

Разработка мастера

Другие ресурсы

Модель мастера Visual C++