VsWizardClass.Execute Method

Called when a wizard is launched from either the Add New Item or New Project dialog boxes.

Namespace:  Microsoft.VisualStudio.VsWizard
Assembly:  Microsoft.VisualStudio.VsWizard (in Microsoft.VisualStudio.VsWizard.dll)

Syntax

'Declaration
Public Overridable Sub Execute ( _
    Application As Object, _
    hwndOwner As Integer, _
    ByRef ContextParams As Object(), _
    ByRef CustomParams As Object(), _
    <OutAttribute> ByRef retval As wizardResult _
)

public virtual void Execute(
    Object Application,
    int hwndOwner,
    ref Object[] ContextParams,
    ref Object[] CustomParams,
    out wizardResult retval
)

public:
virtual void Execute(
    [InAttribute] Object^ Application, 
    [InAttribute] int hwndOwner, 
    [InAttribute] array<Object^>^% ContextParams, 
    [InAttribute] array<Object^>^% CustomParams, 
    [InAttribute] [OutAttribute] wizardResult% retval
)

abstract Execute : 
        Application:Object * 
        hwndOwner:int * 
        ContextParams:Object[] byref * 
        CustomParams:Object[] byref * 
        retval:wizardResult byref -> unit  
override Execute : 
        Application:Object * 
        hwndOwner:int * 
        ContextParams:Object[] byref * 
        CustomParams:Object[] byref * 
        retval:wizardResult byref -> unit

public function Execute(
    Application : Object, 
    hwndOwner : int, 
    ContextParams : Object[], 
    CustomParams : Object[], 
    retval : wizardResult
)

Parameters

• Application
  Type: System.Object

  Required. A dispatch pointer to the highest-level automation object for the Visual Studio environment.

• hwndOwner
  Type: System.Int32

  Required. The hWnd handle for the parent of the wizard's window.

• ContextParams
  Type: array<System.Object[]%

  Required. An array of elements that vary, depending on whether your wizard is launched from the Add New Item or New Project dialog boxes. See ContextParams Enum for a list of available values.

• CustomParams
  Type: array<System.Object[]%

  Required. An array of user-defined parameters, determined by the param= statements in the wizard's .vsz file. You can use the parameters passed in this array to customize a wizard's behavior and role. See Predefined CustomWizard Symbols for a list of available values.

• retval
  Type: EnvDTE.wizardResult%

  Result of the action. A value from the wizardResult enumeration.

Implements

IDTWizard.Execute(Object, Int32, array<Object[]%, array<Object[]%, wizardResult%)

Remarks

Execute is implemented by a wizard writer to display the appropriate wizard. It is called when a wizard is launched from either the Add New Item or the New Project dialog boxes.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

VsWizardClass Class

Microsoft.VisualStudio.VsWizard Namespace

Other Resources

Designing a Wizard

Visual C++ Extensibility Object Model