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

Developer

API Reference

PIM_ICONTACTS_GETNUMFIELDS()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IContacts pim_IContacts_GetFieldName
Description
This method allows applications to count the number of fields the IContacts implementation supports, as well as count the number of subfields a particular field may contain.
This method takes a key identifying the field to query. If the caller specifies a field, the number of subfields will be returned. If the caller wishes to count the (top-level) fields the IContacts objects supports, an empty string should be specified as the field key.
Params
pif
[]:
[in] The pim_IContacts interface.
fieldKey
[]:
[in] The name of the field whose subfields are to be counted, a NULL-terminated string. Pass in the empty string ("") to count all supported top-level fields.
numFields
[]:
[out] On success, the number of children found under the specified field.
Interface
Prototype
  •    AEEResult pim_IContacts_GetNumFields(pim_IContacts *pif,
                                            const char *fieldKey,
                                            int* numFields);
    
Return
  • AEE_SUCCESS : Successful. AEE_EBADITEM : The requested field subtree does not exist. AEE_EUNSUPPORTED : The operation isn't supported by the implementation. Another error code : Otherwise.
Side Effect
  • None
Comments
None