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

Developer

API Reference

IVERSION_GETINFOSTRING()

Brew Release
Brew MP 1.0.2
See Also
None
Description
This method retrieves information like the product name and the vendor name from the installed component.
Params
po
[]:
[in] A pointer to the IVersion object.
nInfoId
[]:
[in] Identifies info string to be retrieved. It is specified as one of the following constants. AEEVERSID_PRODUCTNAME - Use this to retrieve product name. AEEVERSID_VENDORNAME - Use this to retrieve vendor name.
pszBuf
[]:
[out] On return, this will contain requested info string. The string will be NULL terminated. pszBuf is a pre-allocated buffer to store info string.
nBufLen
[]:
[in] The total size (in bytes) of the pszBuf buffer.
pnBufLenReq
[]:
[out] On return, this will contain total size (in bytes) of the buffer required to hold requested info string including NULL termination character.

Interface
Prototype
  •    int IVersion_GetInfoString(IVersion *po, 
                                  int nInfoId, 
                                  char *pszBuf, 
                                  int nBufLen, 
                                  int *pnBufLenReq);
Return
  • SUCCESS: on success.
    Error code otherwise.
Side Effect
  • None
Comments
This function should be called once with nBufLen set to zero to determine the required amount of space to buffer the requested info. The caller should then allocate the required amount of memory and call this function again to retrieve the value. If size of buffer is less than length of info string, then the function will fill the buffer with the truncated info string and will NULL terminate the string.