IupGetHandle

IUP - Portable User Interface

IupGetHandle

Retrieves the identifier of an interface element.

Parameters/Return

Ihandle *IupGetHandle(char *name); [in C]
IupGetHandle(name: string) -> handle: ihandle [in IupLua3]
iup.GetHandle(name: string) -> handle: ihandle [in IupLua5]

name: name of an interface element.

This function returns the identifier of the interface element.

Note

This function is used for integrating IUP and LED. To manipulate an interface element defined in LED, first capture its identifier using function IupGetHandle, passing the name of the interface element as parameter, then use this identifier on the calls to IUP functions – for example, a call to the function that verifies the value of an attribute, IupGetAttribute.

Attention: in Lua, IupGetHandle is not able to get the Ihandle of a IUP element created in C. To get an Ihandle created in C, use IupGetFromC{"name"}.

See Also

IupSetHandle.