Developer

API Reference

IvCalStore_DeleteObjectByOID()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
See Also
IvCalStore_OnDelete
Description
This IvCalStore Interface has been deprecated, use the pim_IRecordStore Interface. This function deletes an object from the calendar data store based on the passed calendar record Object ID.
This Object ID is different from the UID in a calendar component. OID represents the database object ID for an event, todo, journal etc.
Parameters
  • pIvCalStore
    []:
    [in] The IvCalStore Interface pointer.
  • nAEEPropertyOID
    []:
    [in] The IvCalStore ObjectId to be deleted.
Interface
Prototype
   int IvCalStore_DeleteObjectByOID(IvCalStore    *pIvCalStore,                                                 
                                    AEEVProperty  nAEEPropertyOID)
Return
AEE_SUCCESS : If deletion of a record is successful. AEE_EBADPARM : If invalid parameters are passed. AEE_ENOTALLOWED: If database is locked. AEE_EPRIVLEVEL : If no proper privileges. AEE_EFAILED : Otherwise.
Side Effect
None
Comment
Apps can register signals with IvCalStore_OnDelete() API to receive notifications for any deletions from the database. AEEPRIVID_vCalStoreWrite privilege is required to Delete some calendar information in calendar store.
  • Follow