.Vsz 文件(项目控制)

每个向导的起始点均为 .vsz 文件。 .vsz 文件是一个文本文件,确定要调用的向导和传递给向导的信息。 该文件包含两行标头,后跟要传递给向导的各种可选参数。 有关可选参数的列表,请参见预定义自定义向导符号

下面的示例显示 .vsz 文件头:

VSWIZARD 7.0
Wizard=VsWizard.VsWizardEngine.10.0
Param="WIZARD_NAME = My AppWizard"
  • 文件头的第一行指定模板文件格式的版本号。 可以将此数字指定为 6.0、7.0 或 7.1。 其他版本号均无效,使用其他号码会导致“格式无效”错误。

  • 第二行将 Wizard 变量设置为通过 Visual Studio 共同创建的向导的 ProgID。 ProgID 是 CLSID 的字符串表示形式,如 VsWizard.VsWizardEngine.10.0。

    如果向导具有用户界面,则 ProgID 自动指定向导以实现 IVCWizCtlUI。 默认情况下,此界面的方法用于项目的 .htm 文件中。 您可以通过在 .htm 文件中使用此界面的方法,更改向导的行为。 有关更多信息,请参见 VCWizCtl,它是 IVCWizCtlUI 的 coclass。

  • 这两行的后面是可选参数的列表,这些参数允许 .vsz 文件将附加的自定义参数传递到向导。 每个值都将作为一个字符串元素传递到向导控件的 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"
    

向导通过调用函数 CanAddATLClassCanAddMFCClassCanAddClass 确认 Visual C++ 代码模型是否可用。 如果其中一个函数返回 false,则向导不启动。

通过将 .vsz 文件放置在 vcprojects 目录中,可以将向导添加到 Visual Studio 的**“新建项目”**对话框中的“模板”窗格。 默认情况下,“自定义向导”将 .vsz 文件写入此目录。

备注

如果删除向导文件和目录,还必须从 vcprojects 目录中删除项目的 .vsz 文件、.vsdir 文件和 .ico 文件。

请参见

任务

创建自定义向导

参考

自定义向导

概念

为向导创建的文件

使用 .Vsdir 文件为“添加项”和“新建项目”对话框添加向导

设计向导

其他资源

Visual C++ 向导模型