WebWizardHost  Object

IID_IWebWizardHost

{18BCC359-4990-4BFB-B951-3C83702BE5F9}

IID_INewWDEvents

{0751C551-7568-41C9-8E5B-E22E38919236}

WebWizardHost provides methods that enable HTML pages which are hosted in a wizard extension to communicate with the wizard.

NewWDEvents extends the WebWizardHost object by enabling server-side pages hosted in a wizard to verify that the user has been authenticated through Microsoft .NET Passport.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IDispatch Methods

Description

GetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).

GetTypeInfo

Gets the type information for an object.

GetIDsOfNames

Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs.

Invoke

Provides access to properties and methods exposed by an object.

IWebWizard Methods and Properties

Description

FinalBack

Navigates to the client-side page immediately preceding the page hosting the server-side HTML pages.

FinalNext

Navigates to the client-side wizard page following the page that hosts the server-side HTML pages, or finishes the wizard if there are no further client-side pages.

Cancel

Simulates a Cancel button click.

Caption

Not currently implemented.

Property

Sets or retrieves a property's current value.

SetWizardButtons

Updates the Back, Next, and Finish buttons in the client's wizard frame.

SetHeaderText

Sets the title and subtitle that appear in the wizard header. In general, the client will display the header above the HTML and below the title bar.

INewWDEvents Method

Description

PassportAuthenticate

Enables server-side pages hosted in a wizard to verify that the user has been authenticated through Passport.

FinalBack

FUNCTION IWebWizardHost_FinalBack ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING IWebWizardHost_FinalBack (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

FinalNext

FUNCTION IWebWizardHost_FinalNext ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING IWebWizardHost_FinalNext (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Cancel

FUNCTION IWebWizardHost_Cancel ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING IWebWizardHost_Cancel (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Caption

FUNCTION IWebWizardHost_put_Caption ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pbstrCaption AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG
  pbstrCaption = UCODE$(pbstrCaption)
  CALL DWORD @@pthis[10] USING IWebWizardHost_put_Caption (pthis, pbstrCaption) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

FUNCTION IWebWizardHost_get_Caption ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pbstrCaption AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IWebWizardHost_get_Caption (pthis, pbstrCaption) TO HRESULT
  FUNCTION = HRESULT
  pbstrCaption = ACODE$(pbstrCaption)

END FUNCTION

Property

FUNCTION IWebWizardHost_put_Property ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL bstrPropertyName AS STRING _
, BYREF pvProperty AS VARIANT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  bstrPropertyName = UCODE$(bstrPropertyName)
  CALL DWORD @@pthis[12] USING IWebWizardHost_put_Property (pthis, bstrPropertyName, pvProperty) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

FUNCTION IWebWizardHost_get_Property ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL bstrPropertyName AS STRING _
, BYREF pvProperty AS VARIANT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  bstrPropertyName = UCODE$(bstrPropertyName)
  CALL DWORD @@pthis[13] USING IWebWizardHost_get_Property (pthis, bstrPropertyName, pvProperty) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetWizardButtons

FUNCTION IWebWizardHost_SetWizardButtons ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL vfEnableBack AS INTEGER _
, BYVAL vfEnableNext AS INTEGER _
, BYVAL vfLastPage AS INTEGER _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[14] USING IWebWizardHost_SetWizardButtons (pthis, vfEnableBack, vfEnableNext, vfLastPage) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SetHeaderText

FUNCTION IWebWizardHost_SetHeaderText ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL bstrHeaderTitle AS STRING _
, BYVAL bstrHeaderSubtitle AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG
  bstrHeaderTitle = UCODE$(bstrHeaderTitle)
  bstrHeaderSubtitle = UCODE$(bstrHeaderSubtitle)
  CALL DWORD @@pthis[15] USING IWebWizardHost_SetHeaderText (pthis, bstrHeaderTitle, bstrHeaderSubtitle) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

PassportAuthenticate

FUNCTION INewWDEvents_PassportAuthenticate ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL bstrSignInUrl AS STRING _
, BYREF pvfAuthenitcated AS INTEGER _
  ) AS LONG

  LOCAL HRESULT AS LONG
  bstrSignInUrl = UCODE$(bstrSignInUrl)
  CALL DWORD @@pthis[16] USING INewWDEvents_PassportAuthenticate (pthis, bstrSignInUrl, pvfAuthenitcated) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION