IMAPIControl Interface

IID_IMAPIControl

{0002031B-0000-0000-C000-000000000046}

The IMAPIControl interface is used to enable and disable a button control and to perform tasks when a user of a client application clicks the enabled control. Service providers implement control objects to create custom buttons on dialog boxes, such as configuration property sheets, that are defined with display tables.

For more information on working with display tables and control objects, see Display Tables.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMAPIControl Methods

Description

GetLastError

Returns a MAPIERROR structure containing information about the previous error.

Activate

Makes permanent any changes made to an object since the last save operation.

GetState

Retrieves one or more properties.

GetLastError

FUNCTION IMAPIControl_GetLastError ( _
  BYVAL pIMAPIControl AS DWORD PTR _
, BYVAL hResultCode AS LONG _
, BYVAL ulFlags AS DWORD _
, BYREF lppMAPIError AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIControl[3] USING IMAPIControl_GetLastError (pIMAPIControl, hResultCode, ulFlags, lppMAPIError) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

Activate

FUNCTION IMAPIControl_Activate ( _
  BYVAL pIMAPIControl AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYVAL ulUIParam AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIControl[4] USING IMAPIControl_Activate (pIMAPIControl, ulFlags, ulUIParam) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetState

FUNCTION IMAPIControl_GetState ( _
  BYVAL pIMAPIControl AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lpulState AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIControl[5] USING IMAPIControl_GetState (pIMAPIControl, ulFlags, lpulState) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION