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

Developer

API Reference

PIM_ICONTACTS_REMOVECUSTOMFIELD()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IContacts pim_IContacts_CreateCustomField
Description
Removes a user defined field. On success, the user-defined field is removed from the data store. Any data previously stored in the field throughout the contacts store is removed as well.
This routine takes a field key, which is either the name of the field or a uri in the form of "FieldName/SubFieldName".
Params
pif
[]:
[in] The pim_IContacts interface.
fieldName
[]:
[in] The name of the custom field or subfield to remove.
Interface
Prototype
  •    AEEResult pim_IContacts_RemoveCustomField(pim_IContacts *pif,
                                                 const char *fieldName);
    
Return
  • AEE_SUCCESS : The field was removed successully. AEE_EUNSUPPORTED : Custom fields not supported on this device. Another error code : Otherwise.
Side Effect
  • None
Comments
None