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

Developer

API Reference

ICALLHISTORY_ENUMINITBYCALLTYPE()

Brew Release
Brew MP 1.0.2
See Also
Error Codes ICallHistory
Description
This function initializes or resets the enumeration in the Call History list. Only entries of the specified type will be returned when enumerated until ICALLHISTORY_EnumInit is called at which time enumeration will return to a best-effort reverse chronilogical order.
Enumeration of the Call History is defined to be done, in best-effort reverse chronological order. (that is, returned in order from newest to oldest).
Params
pich
[in]:
Pointer to an ICallHistory interface object.
type
[in]:
Call type to enumerate.
Interface
  • ICALLHISTORY
Prototype
  •    const int ICALLHISTORY_EnumInitByCallType(ICallHistory *pche,
                                                 uint16 type);
    
Return
  • AEE_SUCCESS, if successful. AEE_ENOMEMORY, if the implementation cannot allocate memory internally for the operation. AEE_EFAILED, for other errors.
Side Effect
  • None
Comments
The memory pointed to by the returned AEECallHistoryEntry is owned by the ICALLHISTORY object. Its contents will stay valid until the next call to the ICallHistory interface. The contents of the returned pointer *must not* be modified by the caller.