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

Developer

API Reference

IADDRBOOK_GETCATEGORYNAME()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IAddrBook
Description
This function retrieives the text name of the specified category. The returned string is placed in the buffer provided.
Params
po
[in]:
Pointer to the IAddrBook object

c
[in]:
Specifies the category to find the text name for.

pCatName
[]:
[in/out]: On input, this parameter must be a pointer to a valid AECHAR buffer or NULL to query the size of the item. On return, this buffer contains the NULL-terminated AECHAR string name of the specified category.

pnSize
[]:
[in/out]: On input this parameter points to the size of the pCatName buffer in bytes. On return, pnSize is filled with number of bytes written to the pCatName buffer. If pCatName is NULL, pnSize is filled with the number of bytes required to hold this category name.
Interface
  • IADDRBOOK
Prototype
  •    int IADDRBOOK_GetCategoryName
       (IAddrBook *po, 
       AEEAddrCat c, 
       AECHAR *pCatName, 
       int *pnSize
       );
    
Return

  • AEE_SUCCESS: If successful.
    AEE_EBADPARM: If bad parameters are passed in.
    AEE_ADDR_CAT_NOT_SUPPORTED: If the category is not supported.
    AEE_ADDRBOOK_NOCATSUPPORT: If the device does not support categories.
Side Effect
  • None
Comments
If the pCatName buffer is too small to hold the entire category name, the name will be written to the end of the buffer and will be null terminated.