GetMenu

Category: Objects / Menu
Since engine version: 4.9.1.0 GWE

Description

Returns the id of the menu if the object has an open menu. This is usually the id of the menu symbol (idSymbol) unless CreateMenu was used to explicitly use a differing menu id in idMenuID. Returns 0 if there is no menu or no menu symbol.

Syntax

id GetMenu (object pObj);

Parameter

pObj:
Menu object

Remark

A return value of -1 means that no valid symbol could be determined. This may happen e.g. if no object pointer was passed during a global call to the function. Engine defined menus such as Buy, Sell, etc. never return valid ids.

Example

/* Wird bei klick auf Spezial aufgerufen */
protected func ControlSpecial()
{
  /* überhaupt ein Menü offen und ein Symbol angegeben? */
  if(GetMenu())
    /* Mutieren */
    ChangeDef(GetMenu());
  return(1);
}
        
Mutate into the object represented by the symbol.
See also: CloseMenu, CreateMenu, SetMenuDecoration, SetMenuTextProgress
wipfmetz, August 2002