Freigeben über


VSZ-Datei (Projektsteuerung)

Der Ausgangspunkt jedes Assistenten ist die VSZ-Datei.Die VSZ-Datei ist eine Textdatei, die den aufzurufenden Assistenten sowie die Informationen bestimmt, die an den Assistenten übergeben werden.Die Datei enthält einen zweizeiligen Header, gefolgt von verschiedenen optionalen Parametern, die an den Assistenten übergeben werden.Eine Liste optionaler Parameter finden Sie unter Benutzerdefinierte Parameter in der VSZ-Assistentendatei.

Im folgenden Beispiel ist der Header in einer VSZ-Datei dargestellt:

VSWIZARD 7.0
Wizard=VsWizard.VsWizardEngine.10.0
Param="WIZARD_NAME = My AppWizard"
  • Die erste Headerzeile gibt die Versionsnummer des Vorlagendateiformats an.Sie können diese Nummer als 6.0, 7.0 oder 7.1 angeben.Andere Versionsnummern sind nicht zulässig, da andernfalls der Fehler "Ungültiges Format" ausgegeben wird.

  • In der zweiten Zeile wird für die Wizard-Variable die ProgID des Assistenten festgelegt, die gleichzeitig von Visual Studio erstellt wird.Eine ProgID entspricht der Zeichenfolgendarstellung einer CLSID, z. B. VsWizard.VsWizardEngine.10.0.

    Wenn der Assistent eine Benutzeroberfläche besitzt, legt die ProgID automatisch fest, dass der Assistent IVCWizCtlUI implementiert.Die Methoden dieser Oberfläche werden standardmäßig in den projektspezifischen HTM-Dateien verwendet.Sie können Änderungen am Verhalten des Assistenten vornehmen, indem Sie die Methoden für diese Oberfläche in den HTM-Dateien verwenden.Weitere Informationen finden Sie unter den Erläuterungen zu VCWizCtl, der Co-Klasse von IVCWizCtlUI.

  • Auf diese beiden Zeilen folgt eine optionale Parameterliste, die es der VSZ-Datei ermöglicht, weitere benutzerdefinierte Parameter an den Assistenten zu übergeben.Jeder Wert wird als Zeichenfolgenelement in einem Variantenarray an die Execute-Methode des Wizard-Steuerelements übergeben.Ein Assistent mit Benutzeroberfläche erzeugt standardmäßig die folgenden Parameter:

    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>"
    

    Wenn der Assistent keine Benutzeroberfläche besitzt, weist er anstelle des Parameters IMAGES_PATH die folgenden Parameter auf:

    Param="WIZARD_UI = FALSE"
    Param="SOURCE_FILTER = txt"
    
  • Die VSZ-Datei kann die folgenden Parameter enthalten, die Funktionen in der Datei Common.js festlegen:

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

Die Funktionen CanAddATLClass, CanAddMFCClass und CanAddClass werden vom Assistenten aufgerufen, um die Verfügbarkeit des Visual C++-Codemodells zu bestätigen.Wenn eine der Funktionen den Wert false zurückgibt, wird der Assistent nicht gestartet.

Sie können den Assistenten dem Bereich "Vorlagen" im Dialogfeld Neues Projekt von Visual Studio hinzufügen, indem Sie die VSZ-Datei im Verzeichnis "vcprojects" ablegen.Der benutzerdefinierte Assistent schreibt die VSZ-Datei standardmäßig in dieses Verzeichnis.

HinweisHinweis

Wenn Sie die Assistentendateien und -verzeichnisse löschen, müssen Sie zusätzlich die VSZ-, VSDIR- und ICO-Projektdateien aus dem Verzeichnis "vcprojects" löschen.

Siehe auch

Aufgaben

Erstellen eines benutzerdefinierten Assistenten

Referenz

Benutzerdefinierter Assistent

Konzepte

Für den Assistenten erstellte Dateien

Hinzufügen von Assistenten zu den Dialogfeldern Element hinzufügen und Neues Projekt mithilfe von VSDIR-Dateien

Entwerfen eines Assistenten

Weitere Ressourcen

Visual C++-Assistentenmodell