GetObjectAsPointer Method (WINDOW or PANEL)

9.2C, PLBCMP GUI Only

The GetObjectAsPointer method returns the program UDA address for a GUI object that is contained by a WINDOW or PANEL object. The UDA address is stored into an OBJECT variable as specified by the GIVING parameter. This OBJECT variable is a pointer that can then be used to reference the object in PL/B instructions. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A WINDOW or PANEL object that is accessed.

return

Optional. An OBJECT variable that receives the program address of the GUI object that is identified by the {key}.

key

Required. A Character String Variable, literal, or Numeric Variable that identifies the GUI object to be retrieved from the {object}.

flags

Optional. A Numeric Variable or decimal number whose value is a bit mask definition to control the operations of the GetObjectAsPointer method.

Flags Affected: OVER, ZERO

Note the following:

1. The ZERO flag is set when the GUI object address value is zero that was stored into the {object} variable.

2. The OVER flag is set when the requested GUI object specified by the {key} parameter does not exist.

3. The {key} parameter is required. When it is specified as a Character String Variable or literal, the string data is the RUNTIME property name for the GUI object that is being retrieved. When the {key} parameter is specified as a Numeric Variable or value, the numeric value is the zero-based index number used to retrieve the GUI object from the {object} child list.

4. The {flags] parameter is a bit masked value that controls the method operations when used with a WINDOW object as follows:

See Also: Method Syntax, Panel Methods, WINDOW Methods