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

Developer

API Reference

PIM_ICONTACTS_UPDATERECORD()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IContacts
Description
This function is used to update an existing record. The record to update is identified via the recordId parameter. Its contents are replaced with the record passed in to this routine.
Params
pif
[]:
[in] The pim_IContacts interface.
recordId
[]:
[in] The ID of the record to be udpated on the device.
record
[]:
[in] The new or modified record that will replace the record at the given recordID.
Interface
Prototype
  •    AEEResult pim_IContacts_UpdateRecord(
          pim_IContacts *pif,
          int recordId,
          pim_IContactsRecord *record);
    
Return
  • AEE_SUCCESS : Successful record udpate. AEE_EBADITEM : the record specified was missing fields or was otherwise unacceptable to the underlying implementation. Another error code : otherwise.
Side Effect
  • None
Comments
Note that it is the caller's responsibility to verify the record passed to this routine adheres to the record requirements dictated in the class documentation. For example, when adding a record to the EFS-based contacts databse, the application must be careful to include all of the mandatory fields in the record, etc., as laid out in the pim_AEECLSID_EFSDBDevice documentation. Failure to do so will result in an AEE_EBADITEM return code.