IMAPIProp Interface

IID_IMAPIProp

{00020303-0000-0000-C000-000000000046}

The IMAPIProp interface is implemented by all objects that support properties. It is used by clients, service providers, and MAPI to work with properties.

IMAPIProp is the base interface for the following interfaces: IAttach, IMailUser, IMAPIContainer, IMAPIFormInfo, IMAPIStatus, IMessage, IMsgStore, IProfSect, IPropData.

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.

GetLastError

FUNCTION IMAPIProp_GetLastError ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL hResultCode AS LONG _
, BYVAL ulFlags AS DWORD _
, BYREF lppMAPIError AS DWORD _
  ) AS LONG

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

END FUNCTION

SaveChanges

FUNCTION IMAPIProp_SaveChanges ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[4] USING IMAPIProp_SaveChanges (pIMAPIProp, ulFlags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetProps

FUNCTION IMAPIProp_GetProps ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL lpPropTagArray AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYREF lpcValues AS DWORD _
, BYREF lppPropArray AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[5] USING IMAPIProp_GetProps (pIMAPIProp, lpPropTagArray, ulFlags, lpcValues, lppPropArray) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

GetPropList

FUNCTION IMAPIProp_GetPropList ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL ulFlags AS DWORD _
, BYREF lppPropTagArray AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[6] USING IMAPIProp_GetPropList (pIMAPIProp, ulFlags, lppPropTagArray) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

OpenProperty

FUNCTION IMAPIProp_OpenProperty ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL ulPropTag AS DWORD _
, BYVAL lpiid AS DWORD _
, BYVAL ulInterfaceOptions AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYREF lppUnk AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[7] USING IMAPIProp_OpenProperty (pIMAPIProp, ulPropTag, lpiid, ulInterfaceOptions, ulFlags, lppUnk) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetProps

FUNCTION IMAPIProp_SetProps ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL cValues AS DWORD _
, BYVAL lpPropArray AS DWORD _
, BYVAL lppProblems AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[8] USING IMAPIProp_SetProps (pIMAPIProp, cValues, lpPropArray, lppProblems) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

DeleteProps

FUNCTION IMAPIProp_DeleteProps ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL lpPropTagArray AS DWORD _
, BYVAL lppProblems AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[9] USING IMAPIProp_DeleteProps (pIMAPIProp, lpPropTagArray, lppProblems) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

CopyTo

FUNCTION IMAPIProp_CopyTo ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL ciidExclude AS DWORD _
, BYVAL rgiidExclude AS DWORD _
, BYVAL lpExcludeProps AS DWORD _
, BYVAL ulUIParam AS DWORD _
, BYVAL lpProgress AS DWORD _
, BYREF lpInterface AS GUID _
, BYVAL lpDestObj AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYVAL lppProblems AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[10] USING IMAPIProp_CopyTo (pIMAPIProp, ciidExclude, rgiidExclude, lpExcludeProps, ulUIParam, lpProgress, lpInterface, lpDestObj, ulFlags, lppProblems) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

CopyProps

FUNCTION IMAPIProp_CopyProps ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL lpIncludeProps AS DWORD _
, BYVAL ulUIParam AS DWORD _
, BYVAL lpProgress AS DWORD _
, BYREF lpInterface AS GUID _
, BYVAL lpDestObj AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYVAL lppProblems AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[11] USING IMAPIProp_CopyProps (pIMAPIProp, lpIncludeProps, ulUIParam, lpProgress, lpInterface, lpDestObj, ulFlags, lppProblems) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetNamesFromIDs

FUNCTION IMAPIProp_GetNamesFromIDs ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL lppPropTags AS DWORD _
, BYVAL lpPropSetGuid AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYVAL lpcPropNames AS DWORD _
, BYVAL lpppPropNames AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[12] USING IMAPIProp_GetNamesFromIDs (pIMAPIProp, lppPropTags, lpPropSetGuid, ulFlags, lpcPropNames, lpppPropNames) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetIDsFromNames

FUNCTION IMAPIProp_GetIDsFromNames ( _
  BYVAL pIMAPIProp AS DWORD PTR _
, BYVAL cPropNames AS DWORD _
, BYVAL lppPropNames AS DWORD _
, BYVAL ulFlags AS DWORD _
, BYREF lppPropTags AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pIMAPIProp[13] USING IMAPIProp_GetIDsFromNames (pIMAPIProp, cPropNames, lppPropNames, ulFlags, lppPropTags) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION