.vsz ファイル (プロジェクト コントロール)
更新 : 2007 年 11 月
ウィザードは .vsz ファイルで開始します。.vsz ファイルとは、呼び出されるウィザードとそのウィザードに渡す情報を指定するテキスト ファイルです。このファイルには、2 行のヘッダーの後に、ウィザードに渡すさまざまな省略可能パラメータが指定されています。省略可能なパラメータのリストについては、「ウィザードの .vsz ファイルのカスタム パラメータ」を参照してください。
.vsz ファイルのヘッダーの例を次に示します。
VSWIZARD 7.0
Wizard=VsWizard.VsWizardEngine.8.0
Param="WIZARD_NAME = My AppWizard"
ヘッダーの最初の行は、テンプレート ファイル形式のバージョン番号を指定します。この番号として、6.0、7.0、または 7.1 を指定できます。それ以外の番号は無効です。無効な番号を使用すると、"無効な形式" エラーが発生します。
2 行目は、Wizard 変数を Visual Studio で一緒に作成されるウィザードの ProgID に設定します。ProgID は、VsWizard.VsWizardEngine.8.0 のような、CLSID の文字列形式です。
ウィザードにユーザー インターフェイスがある場合は、ウィザードが IVCWizCtlUI を実装するように ProgID で自動的に指定されます。既定では、このインターフェイスのメソッドは、プロジェクトの .htm ファイルで使用されます。.htm ファイルでこのインターフェイスのメソッドを使用すると、ウィザードの動作を変更できます。詳細については、IVCWizCtlUI のコクラスである VCWizCtl に関するトピックを参照してください。
この 2 行の後には、省略可能なパラメータのリストが指定されます。これにより、.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"
CanAddATLClass、CanAddMFCClass、および CanAddClass の各関数は、Visual C++ コード モデルが使用できることを確認するためにウィザードによって呼び出されます。いずれかの関数が false を返すと、ウィザードは起動しません。
.vsz ファイルを vc7\vcprojects ディレクトリに格納することによって、Visual Studio の [新しいプロジェクト] ダイアログ ボックスのテンプレート ペインにウィザードを追加できます。既定では、カスタム ウィザードによって .vsz ファイルがこのディレクトリに作成されます。
メモ : |
---|
ウィザードのファイルとディレクトリを削除する場合は、vc7\vcprojects ディレクトリからプロジェクトの .vsz ファイル、.vsdir ファイル、および .ico ファイルも削除する必要があります。 |
参照
処理手順
概念
.vsdir ファイルを使用した [項目の追加] ダイアログ ボックスおよび [新しいプロジェクト] ダイアログ ボックスへのウィザードの追加