SAP ABAP Data Element O2BYREF (Attribute: Reference Transfer)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-BSP (Application Component) Business Server Pages
     ⤷ SBSP_DEVTAGLIB (Package) Development Environment Objects for Taglib Support

Basic Data

Data Element	O2BYREF
Short Description	Attribute: Reference Transfer

Data Type

Category of Dictionary Type	D	Domain
Type of Object Referenced		No Information
Domain / Name of Reference Type	CHAR1
Data Type	CHAR	Character String
Length	1
Decimal Places	0
Output Length	1
Value Table

Further Characteristics

Search Help: Name
Search Help: Parameters
Parameter ID
Default Component name
Change document	☐
No Input History	☐
Basic direction is set to LTR	☐
No BIDI Filtering	☐

Field Label

	Length	Field Label
Short	10	Reference
Medium	16	Call by ref.
Long	20	Call by reference
Heading	0

Documentation

Definition

Defines whether the attribute is passed to the element handler class using reference transfer.

Use

Reference transfer is appropriate if the BSP element is to have access to large data sets of the BSP page (for example, an internal table), for which a transfer "by-value" would not be suitable.

It can also be used if the BSP element is to change the content of a variable defined in the BSP page. In this case, you must define the relevant attribute as TYPE REF TO.

Dependencies

Example

The element <xyz:increment> is to increase the content of the transferred variable by 1. The value attribute is defined as "Dynamic Value Allowed", "Reference Transfer", and "TYPE REF TO I".

Call example: <xyz:increment value="<%=my_var%>"/>, where my_var is a page attribute of type I.

The redefinition of the interface method DO_AT_BEGINNING could read as follows:

METHOD IF_BSP_ELEMENT~DO_AT_BEGINNING. 
  ... 
  ADD 1 TO value->*. 
  ... 
  rc = CO_ELEMENT_DONE. 
ENDMETHOD.

History

Last changed by/on	SAP	20040312
SAP Release Created in	620