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

Developer

API Reference

IVPROPERTY_GETGROUPNAME()

Brew Release
Brew MP 1.0.2
See Also
None
Description
Get the property group-name if it belongs to some group.
Params
pIvProperty
[]:
Pointert to the IvProperty interface
pszBuf
[]:
Pointer to the buffer where group name will be stored.
nBufSize
[]:
size of pszBuf.
pnBufSizeReq
[]:
If pszBuf is NULL, the size required is returned,
Interface
Prototype
  •    int IvProperty_GetGroupName(IvProperty  *pIvProperty,
                                   char        *pszBuf,
                                   int         nBufSize,
                                   int         *pnBufSizeReq);
    
Return
  • AEE_SUCCESS : If the name was stored completely in the buffer AEE_ENOTYPE : If there is no group name assosciated AEE_EBADPARM : If the pnBufSizeReq is NULL.
Side Effect
  • None.
Comments
If user passes in a valid pszBuf pointer but not of complete size to hold the entire buffer we fill in as much as we can, and update the pnBufSizeReq with the actual size required and return the value as AEE_SUCCESS