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

Developer

API Reference

IADDRBOOK_ENUMRECINITEX()

Brew Release
Brew MP 1.0.2
See Also
AEEAddrCat AEEAddrEnumRecInfo AEEAddrFieldID Error Codes IAddrBook IADDRBOOK_EnumNextRec IADDRBOOK_EnumFieldsInfoInit IADDRBOOK_EnumNextFieldsInfo
Description
This function initializes the enumeration of records in the address book based on a specified search criteria. After enumeration has been initialized, the IADDRBOOK_EnumNextRec() function can be used to iterate through the records that match this search criteria.
Params
pIAddrBook
[]:
Pointer to the IAddrBook Interface object.
pEnumRecInfo
[]:
Pointer to an AEEAddrEnumRecInfo struct that specifies the search criteria.
Example
[]:
To walk through all the records in the address book, use the following code.
	
    EnumRecInfo.nCategories = 0;
    EnumRecInfo.nFields = 0;
    EnumRecInfo.nTypes = 0;
    EnumRecInfo.dwDataSize = 0;
    IADDRBOOK_EnumRecInitEx
       (
       pIAddrBook,
       &EnumRecInfo
       );
Interface
  • IADDRBOOK
Prototype
  •     int IADDRBOOK_EnumRecInit
        (
        IAddrBook * pIAddrBook,
        AEEAddrEnumRecInfo * pEnumRecInfo
        );
    
Return
  • AEE_SUCCESS : If a match was found. AEE_EFAILED : If the IADDRBOOK_EnumRecInitEx() function failed.
Side Effect
  • None
Comments
Parital matches may be performed by appropriately setting the flags parameter in the AEEAddrEnumRecInfo struct.