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

Developer

API Reference

PIM_ICONTACTS_REMOVECUSTOMGROUP()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IContacts pim_IContacts_GetGroupName
Description
Removes a user defined group. On success, the user-defined group is removed from the store.
Not all implementations of IContacts support the addition of user- defined groups. An error code of AEE_EUNSUPPORTED will be returned from this method if the implementation doesn't allow the creation of user-defined groups.
Params
pif
[]:
[in] The pim_IContacts interface.
groupName
[]:
[in] The UTF-16 encoded wide-string name of the Group to remove.
Interface
Prototype
  •    AEEResult pim_IContacts_RemoveCustomGroup(pim_IContacts *pif,
                                                 const AECHAR *groupName);
    
Return
  • AEE_SUCCESS : Group was removed successully. AEE_EUNSUPPORTED : Custom fields are not supported on this device. AEE_EBADITEM : if a non-existent group was specified Another error code : Otherwise.
Side Effect
  • None
Comments
None