GET PROPERTY - OLE

Short Reference

Syntax

GET PROPERTY OF ole attr = dobj [NO FLUSH] [QUEUE-ONLY].

Extras:

1. ... NO FLUSH

2. ... QUEUE-ONLY

Effect

The content of attribute attr of an Automation object ole is assigned to data object dobj. The Automation object must have been created using the special CREATE OBJECT statement for Automation objects. For the typing of ole, the description of the CREATE OBJECT statement applies. The typing of the dobj data object depends on the properties of the Automation attribute attr.

System Fields

sy-subrc Meaning
0 Object attributes successfully passed.
1 Error in communication with SAP GUI.
2 Error in function call in SAP GUI.
3 Error when setting an attribute.
4 Error when reading an attribute.

Addition 1

... NO FLUSH

Addition 2

... QUEUE-ONLY

Effect

For the description of the NO FLUSH and QUEUE-ONLY additions, refer to the description of the CREATE OBJECT statement.

Example

In this example, the attribute "Visible" of an Excel table, which was created at runtime, is read. This attribute specifies whether the table processing is visible or runs in the background. The variable vis is typed as an integer, because Excel passes an integer value.

TYPE-POOLS ole2.

DATA: vis TYPE i,
      app TYPE ole2_object.

CREATE OBJECT   app 'Excel.Application'.
GET PROPERTY OF app 'Visible' = vis.
WRITE vis.