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

Developer

API Reference

PIM_ICONTACTS_SETGROUPINFO()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IContacts pim_IContacts_GetGroupName pim_IContacts_GetGroupInfo
Description
This function stores group-specific information given its name. The information that's to be stored is identified by the string passed in as the groupInfoKey parameter. This method can be used by applications to store group-specific info such as references to a group icon, ringtone, etc.
Note that different implementations of IContacts support different types of group information. For example, "GroupName" field may be used to change the name of the group in some implementations. Please refer to the class documentation to identify valid pszGroupInfoKey values.
Params
pif
[]:
[in] The pim_IContacts interface.
groupName
[]:
[in] The UTF-16 encoded wide-string name of the group to set information for.
groupInfoKey
[]:
[in] A string indentifying the information to store.
groupInfo
[]:
[in] A UTF-16 encoded wide-string containing the group information to store.
Interface
Prototype
  •    AEEResult pim_IContacts_SetGroupInfo(pim_IContacts *pif,
                                            const AECHAR* groupName, 
                                            const char *groupInfoKey,
                                            AECHAR *groupInfo);
    
Return
  • AEE_SUCCESS : Successful. AEE_EUNSUPPORTED : Groups aren't supported by the implementation. AEE_EBADITEM : An unsupported key was specified. Another error code : Otherwise.
Side Effect
  • None
Comments
None