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

Developer

API Reference

IVPROPERTY_GETPROPERTYNAME()

Brew Release
Brew MP 1.0.2
See Also
IvProperty_GetId
Description
Get the property name
Params
pIvProperty
[]:
Pointert to the IvProperty interface
pszBuf
[]:
Pointer to the buffer where the name will be stored.
nBufSize
[]:
Size of pszBuf.
pnBufSizeReq
[]:
If pszBuf is NULL, the size required is returned,
Interface
Prototype
  •    int IvProperty_GetPropertyName(IvProperty *pIvProperty,
                                      char       *pszBuf,
                                      int        nBufSize,
                                      int        *pnBufSizeReq);
      
Return
  • AEE_SUCCESS : If the name was stored completely in the buffer AEE_EBADPARM : If the pnBufSizeReq is NULL.
Side Effect
  • None.
Comments
Useful for extended properties, when Parser itself does not know about the property. 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