IMAPIFormInfo Interface

IID_IMAPIFormInfo

{00020324-0000-0000-C000-000000000046}

The IMAPIFormInfo interface gives client applications access to useful properties particular to form definition. By keeping form information in a separate object, the form library provider can describe a form to a client without activating the form.

Unlike most interfaces defined in the MAPIFORM.H header file, IMAPIFormInfo inherits from the IMAPIProp interface, as it exports most form information through calls to the IMAPIProp::GetProps method.

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMAPIProp Methods

Description

GetLastError

Returns a MAPIERROR structure containing information about the previous error.

SaveChanges

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

GetProps

Retrieves one or more properties.

GetPropList

Returns property tags for all properties.

OpenProperty

Returns a pointer to an interface to be used to access a property.

SetProps

Updates one or more properties.

DeleteProps

Deletes one or more properties.

CopyTo

Copies or moves all properties, except for specifically excluded properties.

CopyProps

Copies or moves selected properties.

GetNamesFromIDs

Provides the property names that correspond to one or more property identifiers.

GetIDsFromNames

Provides the property identifiers that correspond to one or more property names.

IMAPIFormInfo Methods

Description

CalcFormPropSet

Returns a pointer to the complete set of properties used by a form.

CalcVerbSet

Returns a pointer to the complete set of verbs used by a form.

MakeIconFromBinary

Builds an icon from an icon property of a form.

SaveForm

Saves a description of a particular form in a configuration file.

OpenFormContainer

Returns a pointer to the form container in which a particular form is installed.

CalcFormPropSet

FUNCTION IMAPIFormInfo_CalcFormPropSet ( _
  BYVAL pIMAPIFormInfo AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF ppFormPropArray AS SMAPIFormPropArray _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFormInfo[14] USING IMAPIFormInfo_CalcFormPropSet (pIMAPIFormInfo, ulFlags, ppFormPropArray) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

CalcVerbSet

FUNCTION IMAPIFormInfo_CalcVerbSet ( _
  BYVAL pIMAPIFormInfo AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF ppMAPIVerbArray AS SMAPIVerbArray _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFormInfo[15] USING IMAPIFormInfo_CalcVerbSet (pIMAPIFormInfo, ulFlags, ppMAPIVerbArray) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

MakeIconFromBinary

FUNCTION IMAPIFormInfo_MakeIconFromBinary ( _
  BYVAL pIMAPIFormInfo AS DWORD PTR _
, BYVAL nPropID AS DWORD _
, BYREF phicon AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFormInfo[16] USING IMAPIFormInfo_MakeIconFromBinary (pIMAPIFormInfo, nPropID, phicon) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

SaveForm

FUNCTION IMAPIFormInfo_SaveForm ( _
  BYVAL pIMAPIFormInfo AS DWORD PTR _
, BYREF szFileName AS ASCIIZ _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFormInfo[17] USING IMAPIFormInfo_SaveForm (pIMAPIFormInfo, szFileName) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

OpenFormContainer

FUNCTION IMAPIFormInfo_OpenFormContainer ( _
  BYVAL pIMAPIFormInfo AS DWORD PTR _
, BYREF ppformcontainer AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIFormInfo[18] USING IMAPIFormInfo_OpenFormContainer (pIMAPIFormInfo, ppformcontainer) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION