|
VADELIA |
|
|
MADELIA |
|
(I/B) |
|
|
(I) |
Note: This function can only be used in Windows client parts.
Description
Returns the graphic object variable whose static name is set as a parameter. This static name can be partially or fully qualified.
Syntax
Result = &GET_OBJECT(Static_Name)
Parameters
|
Description |
Contents |
Controls |
Result |
GRAPHIC_OBJECT variable. |
Graphic object (control, window, menu) being searched for. |
|
Static name |
ALPHA variable or constant. |
Contains the partially- or fully-qualified static name of the object to be found. |
Mandatory parameter. |
Possible static name syntaxes:
Object type |
Syntax 1 |
Syntax 2 |
Syntax 3 |
Object |
PgmName.WinName.ObjectName |
WinName.ObjectName |
ObjectName |
Window |
PgmName.WinName.WinName |
WinName.WinName |
WinName |
WinMenuItem |
PgmName.WinName.WinName[MenuId] |
WinName.WinName[MenuId] |
WinName[MenuId] |
ObjectMenuItem |
PgmName.WinName.ObjectName[MenuEvt] |
WinName.ObjectName[MenuId] |
ObjectName[MenuId] |
Notes:
PgmName is the short name of a program.
When the object's static name is not fully qualified, the program generator completes the name using data from the current context (i.e. the current program and window and the destination graphic object's type). In most cases, if the generation stage is unable to obtain the additional information from the current context, in order to define a fully-qualified object name, the function returns *NULL_OBJECT.
- If the generator is unable to specify the expected object type (e.g. &GET_OBJECT() = &GET_OBJECT()), the function returns:
. the object's handle if the name is fully qualified,
. *NULL_OBJECT if it is not.
- If the name is not fully qualified but the expected type is *WINDOW, the function returns the handle of the window that matches the name.
- If the name is fully qualified but the object's type is not as expected, the function returns *NULL_OBJECT. This prevents incompatible objects from being assigned to GRAPHIC_OBJECT variables.
If the specified object cannot be identified (partially qualified name + information) or does not exist, the function returns the value *NULL_OBJECT. To determine why a *NULL_OBJECT result was returned, you should use the &CONTROL_OBJECT function.
Example
GRAPHIC_OBJECT(COMBO_BOX) CbxObjVar
CbxObjVar = &GET_OBJECT('COMBOBOX1')
CbxObjVar = &GET_OBJECT('WIN1_ID.COMBOBOX1')
CbxObjVar = &GET_OBJECT('MYPGM.WIN1_ID.COMBOBOX1')
List of predefined functions by topic