HrMAPIOpenCachedProp

The HrMAPIOpenCachedProp function creates a new (local) MAPI IPropData object where the original object properties are cached.

Quick Info

HRESULT HrMAPIOpenCachedProp(
  LPMAPIPROP lpObj,            
  LPSPropTagArray lpPropList,  
  ULONG dwFlags,               
  LPPROPDATA FAR * lppCachedObj  
);
 

Parameters

lpObj

Input parameter. Points to a MAPI IMAPIProp interface containing the source object.

lpPropList

Input parameter. List of properties to cache.

dwFlags

Input parameter. Open for reading only or writing only.

lppCachedObj

Output parameter. Points to an IPropData interface containing the cached version of source object.

Return Values

See Return Values.

Remarks

The local cached version of the source object can be created for reading (for use with HrMAPIGetProp* calls) for for writing (for use with HrMAPISetProp* calls). The purpose of the HrMAPIOpenCachedProp function and HrMAPICloseCachedProp is to reduce the number of remote procedure calls made by the code which performs many HrMAPIGetProp* or HrMAPISetProp* calls on an object.

This function creates a cached object for reading only or writing only. It does not support an object for both reading and writing.

For information on the IMAPIProp and IPropData interfaces, see the MAPI Programmer's Reference.

See Also

HrMAPICloseCachedProp