Developer

API Reference

IvCalStore_GetObjectOIDs()

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
None
Description
This IvCalStore Interface has been deprecated, use the pim_IRecordStore Interface. This function gets all the OIDs for a particular component type. If the component type is specified as 0 then all the OIDs in the calendar database would be returned back.
Parameters
  • pIvCalStore
    []:
    [in] Pointer to the IvCalStore Interface object
  • ObjId
    []:
    [in] Object type
  • pnAEEPropertyOIDs
    []:
    [in/out] List of OIDs returned
  • nSize
    []:
    [in] Size of the list (number of elements)
  • pnReqSize
    []:
    [in/out] On return will contain the required number of elements (OIDs)
Interface
Prototype
   int IvCalStore_GetObjectOIDs(IvCalStore        *pIvCalStore, 
                                AEECLSID          ObjId, 
                                AEEVProperty      *pnAEEPropertyOIDs,
                                int               nSize,
                                int               *pnReqSize);
Return
AEE_SUCCESS : If the OIDs are retrieved successfully. 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
In Order to get all OIDs in the DB, specify ObjId as 0.
This API would return the number of elements (OIDs) to be returned if pnAEEPropertyOIDs is NULL and not the size in bytes. User would first call the API with pnAEEPropertyOIDs as NULL. This would provide the number of elements in pnReqSize. Suppose the number of elements returned are 3, then user would allocate memory for 3 uint32 values and again call the API with pnAEEPropertyOIDs. User would call the API second time with allocated memory and nSize would specify the number of OIDs (same as returned from the first call) to be filled in pnAEEPropertyOIDs. AEEPRIVID_vCalStoreRead privilege is required to get the OIDs information from calendar store.
  • Follow