|
2 | 2 | title: "Wizard (.Vsz) File | Microsoft Docs" |
3 | 3 | ms.custom: "" |
4 | 4 | ms.date: "11/04/2016" |
5 | | -ms.technology: |
| 5 | +ms.technology: |
6 | 6 | - "vs-ide-sdk" |
7 | 7 | ms.topic: "conceptual" |
8 | | -helpviewer_keywords: |
| 8 | +helpviewer_keywords: |
9 | 9 | - ".vsz files" |
10 | 10 | - "vsz files" |
11 | 11 | - "wizards, files" |
12 | 12 | ms.assetid: 72e1d0f3-eef1-455e-b803-96827f030f50 |
13 | 13 | author: "gregvanl" |
14 | 14 | ms.author: "gregvanl" |
15 | 15 | manager: douge |
16 | | -ms.workload: |
| 16 | +ms.workload: |
17 | 17 | - "vssdk" |
18 | 18 | --- |
19 | 19 | # Wizard (.Vsz) File |
20 | | -The integrated development environment (IDE) uses .vsz files to start wizards. These .vsz files contain information that the IDE uses to determine which wizard to call and what information to pass to the wizard. |
21 | | - |
22 | | - A .vsz file is a version of an .ini-formatted text file that has no sections. Information known to the IDE is stored at the beginning of the file. This provides a link between the wizard that the IDE calls and the parameters that are in the .vsz file to be passed to the IDE. The rest of the file provides parameters that are specific to the wizard and that are to be collected by the IDE and passed to the specific wizard. |
23 | | - |
24 | | - The following example shows the contents of a .vsz file. |
25 | | - |
26 | | -``` |
27 | | -VSWizard 8.0 |
28 | | -Wizard=VsWizard.CBlankSiteWizard -or- {123-1234556-123334} |
29 | | -Param="WIZARDNAME = Wizard One" |
30 | | -Param="WIZARDUI = FALSE" |
31 | | -``` |
32 | | - |
33 | | - Following are the parts in the .vsz file. |
34 | | - |
35 | | -|Part|Description| |
36 | | -|----------|-----------------| |
37 | | -|VSWizard|The first parameter in the file is the version number of the template file format. This version number must be 6.0, 7.0, 7.1, or 8.0. Other numbers cannot be started and cause an Invalid Format error.| |
38 | | -|Wizard|This field contains the OLE ProgID of the wizard, or alternatively a GUID string representation of the CLSID of the wizard that is cocreated by the IDE.| |
39 | | -|Param|These parts are optional. You can add as many as needed.| |
40 | | - |
41 | | - The parameters enable the .vsz file to pass additional custom parameters to the wizard. Each value is passed as a string element in an array of variants to the wizard. For more information, see [Custom Parameters](../../extensibility/internals/custom-parameters.md). For information about how to use a .vsz file in the development of custom wizards, see [.Vsz File (Project Control)](/cpp/ide/dot-vsz-file-project-control) |
42 | | - |
43 | | - To add a default locale ID to your .vsz file, specify `FALLBACK_LCID`=xxxx, where xxxx is the locale ID, for example, 1033 for English. When `FALLBACK_LCID` parameter is defined, the wizard uses the supplied fallback locale ID if the current ID is not found. |
44 | | - |
45 | | -## See Also |
46 | | - [Custom Parameters](../../extensibility/internals/custom-parameters.md) |
47 | | - [Wizards](../../extensibility/internals/wizards.md) |
48 | | - [Template Directory Description (.Vsdir) Files](../../extensibility/internals/template-directory-description-dot-vsdir-files.md) |
| 20 | + |
| 21 | +The integrated development environment (IDE) uses .vsz files to start wizards. These .vsz files contain information that the IDE uses to determine which wizard to call and what information to pass to the wizard. |
| 22 | + |
| 23 | +A .vsz file is a version of an .ini-formatted text file that has no sections. Information known to the IDE is stored at the beginning of the file. This provides a link between the wizard that the IDE calls and the parameters that are in the .vsz file to be passed to the IDE. The rest of the file provides parameters that are specific to the wizard and that are to be collected by the IDE and passed to the specific wizard. |
| 24 | + |
| 25 | +The following example shows the contents of a .vsz file. |
| 26 | + |
| 27 | +``` |
| 28 | +VSWizard 8.0 |
| 29 | +Wizard=VsWizard.CBlankSiteWizard -or- {123-1234556-123334} |
| 30 | +Param="WIZARDNAME = Wizard One" |
| 31 | +Param="WIZARDUI = FALSE" |
| 32 | +``` |
| 33 | + |
| 34 | +Following are the parts in the .vsz file. |
| 35 | + |
| 36 | +|Part|Description| |
| 37 | +|----------|-----------------| |
| 38 | +|VSWizard|The first parameter in the file is the version number of the template file format. This version number must be 6.0, 7.0, 7.1, or 8.0. Other numbers cannot be started and cause an Invalid Format error.| |
| 39 | +|Wizard|This field contains the OLE ProgID of the wizard, or alternatively a GUID string representation of the CLSID of the wizard that is cocreated by the IDE.| |
| 40 | +|Param|These parts are optional. You can add as many as needed.| |
| 41 | + |
| 42 | +The parameters enable the .vsz file to pass additional custom parameters to the wizard. Each value is passed as a string element in an array of variants to the wizard. For more information, see [Custom Parameters](../../extensibility/internals/custom-parameters.md). |
| 43 | + |
| 44 | +To add a default locale ID to your .vsz file, specify `FALLBACK_LCID`=xxxx, where xxxx is the locale ID, for example, 1033 for English. When `FALLBACK_LCID` parameter is defined, the wizard uses the supplied fallback locale ID if the current ID is not found. |
| 45 | + |
| 46 | +## See also |
| 47 | + |
| 48 | +- [Custom Parameters](../../extensibility/internals/custom-parameters.md) |
| 49 | +- [Wizards](../../extensibility/internals/wizards.md) |
| 50 | +- [Template Directory Description (.Vsdir) Files](../../extensibility/internals/template-directory-description-dot-vsdir-files.md) |
0 commit comments