#include <SFBAddrBook.h.hpp>

class SFBAddrBook : public SFBBase;

SFMTYPEDEFWRAPPER(SFBAddrBook)

[ public ]
SFBAddrRecSmp CreateRec(
    AEEAddrCat category   // category to which this address belongs. AEE_ADDR_CAT_NONE indicates "don’t care". Using AEE_ADDR_CAT_NONE is not recomended because the device may return null, or add a new category, or add to an existing default category
    AEEAddrField* items   // array of field(s) for the new address record to be put into the address book
    SInt32 itemCount      // number of field(s) in the pItems array of fields 
);

[ public ]
SFCError EnumCategoryInit(Void);

[ public ]
SFCError EnumFieldsInfoInit(
    AEEAddrCat category   // specifies the category for which the field support is to be enumerated. 
                          // if this parameter is set to AEE_ADDR_CAT_NONE, this function initializes the enumeration of all the fields supported for all categories
);

[ public ]
Bool EnumNextCategory(
    AEEAddrCat* category   // contains the category information
);

[ public ]
Bool EnumNextFieldsInfo(
    AEEAddrFieldInfo* fieldInfo   // on input, this must be a valid pointer to the AEEAddrFieldInfo structure.
                                  // if the return value is true, this parameter contains information about the next type of field supported in this category
);

[ public ]
SFBAddrRecSmp EnumNextRec(Void);

[ public ]
SFCError EnumRecInit(
    AEEAddrCat category      // category type to be matched.
                             // if this is set to AEE_ADDR_CAT_NONE, it is ignored
    AEEAddrFieldID fieldId   //AEEAddrFieldID to be matched. 
                             // if this is set to AEE_ADDRFIELD_NONE, it is ignored.
                             // before specifying a field here, it must be checked if the address book permits searching based on this field. 
                             // this can be done using the functions IADDRBOOK_EnumFieldsInfoInit() and IADDRBOOK_EnumNextFieldsInfo()
    VoidPtr data             // if non-null, pData specifies the actual data that must be matched.
                             // if null, it is ignored
    UInt16 dataSize          // specifies the sizeof(pData)
);

[ public ]
SFCError EnumRecInit(
    AEEAddrCat category      // category type to be matched.
                             // if this is set to AEE_ADDR_CAT_NONE, it is ignored
    AEEAddrFieldID fieldId   //AEEAddrFieldID to be matched. 
                             // if this is set to AEE_ADDRFIELD_NONE, it is ignored.
                             // before specifying a field here, it must be checked if the address book permits searching based on this field. 
                             // this can be done using the functions IADDRBOOK_EnumFieldsInfoInit() and IADDRBOOK_EnumNextFieldsInfo()
    SFXBufferPtr data        // if not null, matched data is specified.
                             // if null, failure
);

[ public ]
SFCError GetLastError(Void);

[ public ]
UInt16 GetNumRecs(Void);

[ public ]
UInt32 GetProperties(Void);

[ public ]
SFBAddrRecSmp GetRecByID(
    UInt16 id   // id of the record that needs to be retrieved from the address book
);

[ public, static ]
SFBAddrBookSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBAddrBookSmp NewInstance(
    AEECLSID clsid = AEECLSID_ADDRBOOK   // Class ID
    SFCErrorPtr exception = null         // Error
);

[ public ]
SFCError RemoveAllRecs(Void);

[ public ]
Void SetProperties(
    UInt32 properties   // properties
);