#include <SFBPimCallHistoryUtil.h.hpp>

class SFBPimCallHistoryUtil : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBPimCallHistoryUtil)

[ public ]
SFCError CreateIterator(
    UInt08ConstPtr record   // the pim_IRecordStore format record that is to be parsed into individual Field entries
    SInt32 length           // the number of the elements that can be stored in RSRecord
    IteratorPtr iterator    // on success, the Iterator that should be used with other APIs to parse the record
);

[ public ]
SFCError CreateIterator(
    SFXBufferConstRef record   // the pim_IRecordStore format record that is to be parsed into individual Field entries
    IteratorPtr iterator       // on success, the Iterator that should be used with other APIs to parse the record
);

[ public ]
SFCError CreateRecord(
    FieldConstPtr field      // a collection of Field entries
    SInt32 fieldLen          // the number of Field entries
    UInt08Ptr record         // on success, the CallHistoryUtil Record converted to a pim_IRecordStore format record
    SInt32 recordLen         // the number of the elements that can be stored in RSRecord
    SInt32Ptr recordLenreq   // on success, the number of the elements that make up RSRecord
);

[ public ]
SFCError CreateRecord(
    FieldConstPtr field   // a collection of Field entries
    SInt32 fieldLen       // the number of Field entries
    SFXBufferPtr record   // on success, the CallHistoryUtil Record converted to a pim_IRecordStore format record
);

[ public ]
SFCError DeleteIterator(
    Iterator iterator   // the Iterator object to be deleted
);

[ public ]
SFCError GetFieldValueNum(
    UInt08ConstPtr record     // the pim_IRecordStore record which needs to be parsed
    SInt32 recordLen          // the size of the record
    ACharConstPtr fieldName   // the name of the CallHistory field to be retrieved
    SInt32Ptr num             // on success, the integer value of the next field
);

[ public ]
SFCError GetFieldValueNum(
    SFXBufferConstRef record          // the pim_IRecordStore record which needs to be parsed
    SFXAnsiStringConstRef fieldName   // the name of the CallHistory field to be retrieved
    SInt32Ptr num                     // on success, the integer value of the next field
);

[ public ]
SFCError GetFieldValueStr(
    UInt08ConstPtr record        // the pim_IRecordStore record which needs to be parsed
    SInt32 recordLen             // the size of the record
    ACharConstPtr fieldName      // the name of the CallHistory field to be retrieved
    ACharPtr fieldValue          // on success, the string value of the next field encoded in UTF-8 encoding
    SInt32 fieldValueLen         // the number of the elements in fieldValue
    SInt32Ptr fieldValueLenreq   // on success, the number of the elements that make up fieldValue
);

[ public ]
SFCError GetFieldValueStr(
    SFXBufferConstRef record          // the pim_IRecordStore record which needs to be parsed
    SFXAnsiStringConstRef fieldName   // the name of the CallHistory field to be retrieved
    SFXAnsiStringPtr fieldValue       // on success, the string value of the next field encoded in UTF-8 encoding
);

[ public ]
SFCError GetNextField(
    Iterator iterator             // the Iterator object that was created using the previous call to CreateIterator() or SupportedFieldsIterator to obtain a list of all supported fields
    ACharPtr fieldName            // on success, the name of the next field
    SInt32 nameLen                // the size of fieldName
    SInt32Ptr nameLenreq          // the requested size of fieldName
    FieldValueTypePtr valuetype   // on success, the FieldValueType of the next field
);

[ public ]
SFCError GetNextField(
    Iterator iterator             // the Iterator object that was created using the previous call to CreateIterator() or SupportedFieldsIterator to obtain a list of all supported fields
    SFXAnsiStringPtr fieldName    // on success, the name of the next field
    FieldValueTypePtr valuetype   // on success, the FieldValueType of the next field
);

[ public ]
SFCError GetNextValueNum(
    Iterator iterator   // the Iterator object that was created using the previous call to CreateIterator()
    SInt32Ptr num       // on success, the integer value of the next field.
);

[ public ]
SFCError GetNextValueStr(
    Iterator iterator       // the Iterator object that was created using the previous call to CreateIterator().
    ACharPtr fieldValue     // on success, the string value of the next field encoded in UTF-8 encoding
    SInt32 valueLen         // the number of the elements in fieldValue
    SInt32Ptr valueLenreq   // on success, the number of the elements that make up fieldValue
);

[ public ]
SFCError GetNextValueStr(
    Iterator iterator             // the Iterator object that was created using the previous call to CreateIterator().
    SFXAnsiStringPtr fieldValue   // on success, the string value of the next field encoded in UTF-8 encoding
);

[ public ]
SFCError GetNumFields(
    Iterator iterator   // the Iterator object that was created using the previous call to CreateIterator() or SupportedFieldsIterator to obtain a count of all supported fields
    SInt32Ptr num       // on success, the number of fields in the record for which Itr was created or the total number of supported fields if Itr was SupportedFieldsIterator
);

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

[ public, static ]
SFBPimCallHistoryUtilSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

enum AliasEnum {
    FieldNameSize           = pim_ICallHistoryUtil_FieldNameSize,
    ValueNum                = pim_ICallHistoryUtil_ValueNum,
    ValueStr                = pim_ICallHistoryUtil_ValueStr,
    SupportedFieldsIterator = pim_ICallHistoryUtil_SupportedFieldsIterator
};
SFMTYPEDEFTYPE(AliasEnum)

SFMTYPEDEFALIAS(pim_ICallHistoryUtil_Field, Field)

SFMTYPEDEFALIAS(pim_ICallHistoryUtil_FieldValueType, FieldValueType)

SFMTYPEDEFALIAS(pim_ICallHistoryUtil_Iterator, Iterator)

SFMTYPEDEFALIAS(pim_ICallHistoryUtil_Record, Record)