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

Developer

API Reference

PIM_ICONTACTS_CREATECUSTOMFIELD()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IContacts pim_IContacts_RemoveCustomField
Description
Creates a user defined fieldName. On success, the user-defined fieldName is added to the data store. Records can use the new fieldname. Callers may remove custom fields via the pim_IContacts_RemoveCustomField() method.
This routine takes a field key, which is either the name of the field or a uri in the form of "FieldName/SubFieldName". The newly created custom field will allow for the storage of UTF-16 encoded wide-string data.
Params
pif
[]:
[in] The pim_IContacts interface.
fieldName
[]:
[in] The name of the custom field or subfield to create.
Interface
Prototype
  •    AEEResult pim_IContacts_CreateCustomField(pim_IContacts *pif,
                                                 const char *fieldName);
    
Return
  • AEE_SUCCESS : The field was created successully. AEE_EUNSUPPORTED : Custom fields not supported on this device. Another error code : Otherwise.
Side Effect
  • The newly created field is added to the list of fields the IContacts object supports. This information is written to the underlying contacts store and will persist.
Comments
None