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

Developer

API Reference

AEEADDRFIELDINFO

Brew Release
Brew MP 1.0.2
See Also
AEEAddrFieldType IADDRBOOK_EnumFieldsInfoInit() IADDRBOOK_EnumNextFieldsInfo()
Description
AEEAddrFieldInfo contains information about the fields supported in the address book. It is used in the function IADDRBOOK_EnumNextFieldsInfo() to get detailed information about each field supported in the address book.
Members
  • fieldID: ID of the field.
  • nMaxItems: Maximum allowed number of items of this fieldID in each record.
  • fType: Data type used for storing information about this field.
  • bFieldSearch: Specifies if a search (EnumRec) can be done based on this field. 
           For example, a call can be made to IADDRBOOK_EnumRecInit() to search 
           for all records having a specific value for this given field ID. 
           This search is independent of the category of the record. For example,  
           it can search for all records having a specific value for the field  
           AEE_ADDRFIELD_NAME.
  • bFieldCatSearch: Specifies if a search (EnumRec) can be done based on this field 
           within a category. For example, can IADDRBOOK_EnumRecInit() be used 
           to search for all records of a specific category having a specific 
           value for this field. As a second example, search for all AEE_ADDR_CAT_PERSONAL 
           records having a specific value for the field AEE_ADDRFIELD_NAME. If this flag 
           is FALSE and if bFieldSearch is TRUE, then in calls to IADDRBOOK_EnumRecInit(), 
           the value of AEEAddrCat must be set to AEE_ADDR_CAT_NONE so that the 
           category is ignored during the search.
Definition
  •     typedef struct _AEEAddrFieldInfo {
           AEEAddrFieldID fieldID;
           int nMaxItems;
           AEEAddrFieldType fType;
           boolean bFieldSearch;
           boolean bFieldCatSearch;
        } AEEAddrFieldInfo;
    
Comments
None