Developer

API Reference

IvCalStore_GetObjectByOID()

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_DeleteObjectByOID
Description
This IvCalStore Interface has been deprecated, use the pim_IRecordStore Interface. This function retrieves the Event, Todo, Journal object given its OID. An event may have a time zone information. While adding/storing the event if the time zone component object is attached to the event it would be stored and retrieved back by this API.
Parameters
  • pIvCalStore
    []:
    [in] The IvCalStore Interface pointer.
  • nAEEPropertyOID
    []:
    [in] The IvCalStore Object ID to be retrieved.
  • ppObj
    []:
    [out]Holds pointer to the returned object
Interface
Prototype
   int IvCalStore_GetObjectByOID(IvCalStore     *pIvCalStore,
                                 AEEVProperty   nAEEPropertyOID,                               
                                 IvCalObject    **ppObj);
Return
AEE_SUCCESS : If the object is retrieved 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
AEEPRIVID_vCalStoreRead privilege is required to Read/Get some calendar information in calendar store.
  • Follow