IMAPIForm Interface

IID_IMAPIForm

{00020327-0000-0000-C000-000000000046}

The IMAPIForm interface is used by form viewers to work with form view contexts and form notification, to perform form verbs, and to shut down forms.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMAPIForm Methods

Description

SetViewContext

Establishes a view context for the form.

GetViewContext

Returns the current view context for the form.

ShutdownForm

Closes the form.

DoVerb

Requests that the form perform whatever tasks it associates with a specific verb.

Advise

Registers a form viewer for notifications about events affecting the form.

Unadvise

Cancels a registration for notifications with a form viewer previously established with a call to the IMAPIForm::Advise method.

SetViewContext

FUNCTION IMAPIForm_SetViewContext ( _
  BYVAL pIMAPIForm AS DWORD PTR _
, BYVAL pViewContext AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIForm[3] USING IMAPIForm_SetViewContext (pIMAPIForm, pViewContext) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetViewContext

FUNCTION IMAPIForm_GetViewContext ( _
  BYVAL pIMAPIForm AS DWORD PTR _
, BYREF pViewContext AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIForm[4] USING IMAPIForm_GetViewContext (pIMAPIForm, pViewContext) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

ShutdownForm

FUNCTION IMAPIForm_ShutdownForm ( _
  BYVAL pIMAPIForm AS DWORD PTR _
, BYVAL ulSaveOptions AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIForm[5] USING IMAPIForm_ShutdownForm (pIMAPIForm, ulSaveOptions) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

DoVerb

FUNCTION IMAPIForm_DoVerb ( _
  BYVAL pIMAPIForm AS DWORD PTR _
, BYVAL iVerb AS LONG _
, BYVAL lpViewContext AS DWORD _
, BYVAL hwndParent AS DWORD _
, BYREF lprcPosRect AS RECT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIForm[6] USING IMAPIForm_DoVerb (pIMAPIForm, iVerb, lpViewContext, hwndParent, lprcPosRect) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Advise

FUNCTION IMAPIForm_Advise ( _
  BYVAL pIMAPIForm AS DWORD PTR _
, BYVAL pAdvise AS LONG _
, BYREF pulConnection AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIForm[7] USING IMAPIForm_Advise (pIMAPIForm, pAdvise, pulConnection) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Unadvise

FUNCTION IMAPIForm_Unadvise ( _
  BYVAL pIMAPIForm AS DWORD PTR _
, BYVAL ulConnection AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIForm[8] USING IMAPIForm_Unadvise (pIMAPIForm, ulConnection) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION