_DTE.LaunchWizard メソッド

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

指定したパラメータを使ってウィザードを実行します。

名前空間 : EnvDTE
アセンブリ : EnvDTE (EnvDTE.dll 内)

構文

'宣言
Function LaunchWizard ( _
    VSZFile As String, _
    ByRef ContextParams As Object() _
) As wizardResult
'使用
Dim instance As _DTE
Dim VSZFile As String
Dim ContextParams As Object()
Dim returnValue As wizardResult

returnValue = instance.LaunchWizard(VSZFile, _
    ContextParams)

wizardResult LaunchWizard(
    string VSZFile,
    ref Object[] ContextParams
)

wizardResult LaunchWizard(
    [InAttribute] String^ VSZFile, 
    [InAttribute] array<Object^>^% ContextParams
)

function LaunchWizard(
    VSZFile : String, 
    ContextParams : Object[]
) : wizardResult

パラメータ

VSZFile
型 : System.String

必ず指定します。ウィザードの実行に必要な情報を含む .Vsz (ウィザード) ファイル。

ContextParams
型 : array<System.Object[]%

必ず指定します。ウィザードのパラメータ。最初のパラメータは、Add Item、Add Project、またはカスタム GUID とは異なる起動コンテキストを一意に識別する GUID です。残りの引数はユーザー定義の引数であり、その数や値はウィザードによって異なります。

Visual Basic Windows アプリケーションや Visual C# コンソールアプリケーションなど、Visual Studio に含まれているウィザード (またはテンプレート) には、それらに渡す必要のある一連の必須のコンテキストパラメータがあります。パラメータの詳細については、「ウィザード起動用のコンテキストパラメータ」を参照してください。独自に作成するウィザードについては、パラメータに関する制約がある場合があります。

戻り値

型 : EnvDTE.wizardResult

wizardResult オブジェクト。

解説

IDE のメイン UI スレッドはウィザードの実行と同期しているため、ウィザードが完了するまでユーザーによる操作はできません。

LaunchWizard メソッドを使用して、Visual Studio の項目の追加ウィザードを起動するマクロの例を次に示します。このウィザードは 7 つのカスタムパラメータを使用するため、それぞれのパラメータの値が設定されています。すべての例外は、Try...Catch ブロックでキャッチされます。

例

Sub LaunchWizardExample()
   Dim params() As Object = New Object() { _
     "{0F90E1D0-4999-11D1-B6D1-00A0C90F2744}", _  ' Param 0
     "MyConsoleProject", _                        ' Param 1
     "C:\MyProjects", _                           ' Param 2
     "", _                                        ' Param 3
     False, _                                     ' Param 4
     "", _                                        ' Param 5
     False}                                       ' Param 6
   ' The wizardResult constant determines the state of the wizard, such 
   ' as did it complete or was it canceled, etc.
   Dim res As EnvDTE.wizardResult
   ' Set the project type to a Visual Basic project.
   Dim s As String = _
     DTE.Solution.TemplatePath(VSLangProj.PrjKind.prjKindVBProject)

   ' Launch the Visual Basic Console Application wizard using the
   ' supplied parameters. Any exceptions are caught below.
   Try
      res = DTE.LaunchWizard(s & "ConsoleApplication.vsz", params)
   Catch e1 As System.Exception
      MsgBox("Error: " & e1.Message)
   End Try
End Sub