API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

PIM_IMESSAGESTORE_QUERYINTERFACE()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IMessageStore
Description
This function is inherited from IQI_QueryInterface(). This method retrieves a pointer to an interface conforming to the definition of the specified interface ID. This can be used to query for extended functionality, like future versions or proprietary extensions.
Upon a successful query, the interface is returned with AddRef'ed. The caller is responsible for calling Release() at some point in the future.
Params
pif
[in]:
Pointer to pim_IMessageStore interface
iid
[in]:
A globally unique id to identify the interface that we are trying to query.
ppo
[out]:
Pointer to the interface that we want to retrieve. If the interface is not available, this is set to NULL.
Interface
Prototype
  •    int pim_IMessageStore_QueryInterface(pim_IMessageStore *pif, AEEIID iid, void **ppo);
    
Return
  • AEE_SUCCESS: on success. AEE_ECLASSNOTSUPPORT: if the interface ID is not supported.
Side Effect
  • None
Comments
On failure, QueryInterface() must set *ppo to NULL.