ABAP INCLUDE INCLUDE Statement syntax, information and example SAP source code

INCLUDE


ABAP_ADDITIONS:
1 ... AS name
2 ... RENAMING WITH SUFFIX suffix

What does it do? This statement can only be declared within a structure definition with the additions BEGIN OF and END OF of the statements TYPES , DATA
CLASS-DATA , and
STATICS . It copies all the components of the structured type
struc_type or the structure struc at the specified location to the current structure definition. The INCLUDE statement does not generate a substructure , which means the components are inserted as if they are included individually in place of the INCLUDE statement.
struc_type can be a local structured type, a visible structured type of a global class or global interface, or a structure from the ABAP Dictionary. struc must be a structure of the same program or a visible attribute of a global class or global interface.

Latest notes: The INCLUDE statement described here should no longer be used for the following reasons:

If further structure components are to be added to existing components using the INCLUDE statement or if multiple INCLUDE statements are used in a structure, this can result in syntax errors due to naming conflicts. This is particularly problematic if structures that are not defined in the same program are included and these are to be changed at a later date.

The embedded structures cannot be addressed as such without restrictions.

The necessary metadata is stored again for each component of an embedded structure, whereas the metadata for the components of a substructure is only stored once when the substructure is defined.

In contrast to real substructures, structures embedded using INCLUDE

cannot be declared as static boxes when embedded.
Where possible, real substructures should be formed rather than using the INCLUDE statement. You should at least use the addition RENAMING WITH SUFFIX to prevent naming conflicts. This recommendation also applies to embedding structures in ABAP Dictionary, where the structures of database tables in particular cannot contain any real substructures.

Outside of ABAP objects, flat structures , database tables, or views in ABAP Dictionary can also be specified for struc with the addition
STRUCTURE .

In constant structures defined with CONSTANTS
, no components can be embedded with INCLUDE because these cannot be assigned a start value .

With regard to their alignment , structures embedded with INCLUDE behave like substructures, which means alignment gaps can occur before the first or after the last component. These do not occur when the components are declared directly.

A structure that is integrated using INCLUDE is handled by method GET_COMPONENTS of class
CL_ABAP_STRUCTDESCR of RTTI in the same way as a substructure. The returned component table only contains one row for an embedded structure. The component type is represented by an object from CL_ABAP_STRUCTDESCR , but the AS_INCLUDE column contains the value "X" . The GET_INCLUDED_VIEW_TAB method can be used to resolve the components of embedded structures.

When a static box is copied from one structure to another, its boxed component attribute is also copied.

ABAP_ADDITION_1 ... AS name

What does it do? By specifying the name name after the addition AS , you can either address all components of the embedded structure struc_type or struc together using the name
name , or address individual components using the structure component selector ( - ).
Latest notes: A name name specified with AS name is used only as an addressing option and is ignored in statements such as MOVE-CORRESPONDING or SELECT INTO CORRESPONDING . A component renamed using RENAMING WITH SUFFIX actually has this name and is therefore not ignored.

ABAP_ADDITION_2 ... RENAMING WITH SUFFIX suffix

What does it do? With the addition RENAMING WITH SUFFIX , each individual component is renamed by adding the extension suffix , which prevents naming conflicts between components of the same name. suffix must be specified directly.

Latest notes: Using the RENAMING WITH SUFFIX addition makes it possible to embed an individual structure multiple times.

Example ABAP Coding In this example, the structure week is defined by repeatedly using the components of the structured type t_day . The components of week are all at the same level and can be addressed as follows: week-work_mon , week-free_mon ,
week-work_tue , and so on. Alternatively, they can also be addressed as follows: week-monday-work , week-monday-free ,
week-tuesday-work , and so on.
TYPES: BEGIN OF t_day,
work TYPE c LENGTH 8,
free TYPE c LENGTH 16,
END OF t_day.

DATA BEGIN OF week.
INCLUDE TYPE t_day AS monday RENAMING WITH SUFFIX _mon.
INCLUDE TYPE t_day AS tuesday RENAMING WITH SUFFIX _tue.
INCLUDE TYPE t_day AS wednesday RENAMING WITH SUFFIX _wed.
...
DATA END OF week.