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

Developer

API Reference

ISHELL_GETDEVICEINFOEX()

Brew Release
Brew MP 1.0.2
See Also
Description
This method is used to get specific information about the device. This function takes an ID that specifies what information is needed. The buffer contains the corresponding information on return.
Params
pIShell
[]:
Pointer to the IShell interface object.
nItem
[]:
Specifies the item whose info is needed. Please see the documentation for AEEDeviceItem for the supported device items.
pBuff
[]:
Contains the corresponding information on return. May be NULL, if querying for the size of the item.
pnSize
[]:
[in/out] On input, when pBuff is non-NULL, pnSize specifies the size of pBuff in bytes. On output, pnSize will be set to the number of bytes required to hold the DeviceInfoEx() item data.
Interface
  • ISHELL
Prototype
  • int ISHELL_GetDeviceInfoEx
    (
    IShell *pIShell,
    AEEDeviceItem nItem,
    void *pBuff,
    int *pnSize
    );
    
Return
  • AEE_SUCCESS: If successful. AEE_EBADPARM: If bad parameters are passed in (pnSize is NULL). AEE_EUNSUPPORTED: If this item is not supported.
    Other errors from AEEStdErr.h are possible; for example AEE_ENOMEMORY or AEE_EFAILED when errors gathering the device information occur.
Side Effect
  • None
Comments
This function may partially fill pBuff in the case where pnSize is not large enough to hold all item data. In this case, pnSize will be set to the size required.