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

Developer

API Reference

IMENUCTL_GETITEM()

Brew Release
Brew MP 1.0.2
See Also
CtlAddItem IMenuCtl IMENUCTL_SetItem
Description
This function queries all of the relevant values associated with a menu item, including the following fields:
Image
Image ID (if a resource based)
Image File Name
Text
Item ID
Data
Font

All objects and pointers returned are owned by the menu control. If used, the caller should make copies or increment the reference count of the object. For example, the caller should call IIMAGE_AddRef() on the image pointer returned if the pointer is to be used. If this is done, the caller must also call IIMAGE_Release() when the pointer is no longer needed.
Params
pIMenuCtl
[]:
pointer to the IMenuCtl interface object.
wID
[]:
menu item ID.
pai
[]:
item information structure.
Interface
  • IMENUCTL
Prototype
  •     boolean IMENUCTL_GetItem
        (
          IMenuCtl * pIMenuCtl, 
          uint16 wID, 
          CtlAddItem * pai
        );
    
Return
  • TRUE: if successful. FALSE: if unsuccessful.
Comments
None