GetAttribIMsgOnIStg

Applies to: Office 2010 | Outlook 2010 | Visual Studio

Retrieves attributes of properties on an IMessage object supplied by the OpenIMsgOnIStg function.

Header file:	Imessage.h
Implemented by:	MAPI
Called by:	Client applications and message store providers

HRESULT GetAttribIMsgOnIStg(
  LPVOID lpObject,
  LPSPropTagArray lpPropTagArray,
  LPSPropAttrArray FAR * lppPropAttrArray
);

Parameters

• lpObject
  [in] Pointer to an IMessage object obtained from the OpenIMsgOnIStg function.

• lpPropTagArray
  [in] Pointer to an SPropTagArray structure that contains an array of property tags indicating the properties for which attributes are to be retrieved.

• lppPropAttrArray
  [out] Pointer to a pointer to the returned SPropAttrArray structure that contains the retrieved property attributes.

Return Value

• S_OK
  The call succeeded and has returned the expected value or values.

• MAPI_W_ERRORS_RETURNED
  The call succeeded overall, but one or more properties could not be accessed and were returned with a property type of PT_ERROR.

Remarks

Property attributes can only be accessed on property objects, that is, objects implementing the IMAPIProp : IUnknown interface. To make MAPI properties available on an OLE structured storage object, OpenIMsgOnIStg builds an IMessage : IMAPIProp object on top of the OLE IStorage object. The property attributes on such objects can be set or altered with SetAttribIMsgOnIStg and retrieved with GetAttribIMsgOnIStg.

Note

  GetAttribIMsgOnIStg and SetAttribIMsgOnIStg do not operate on all IMessage objects. They are only valid for IMessage-on-IStorage objects returned by OpenIMsgOnIStg.

The number and positions of the attributes in the lppPropAttrArray parameter correspond to the number and positions of the property tags in the lpPropTagArray parameter.