RP_OPTIONS_INTO_STRING SAP Function module

RP_OPTIONS_INTO_STRING is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name RP_OPTIONS_INTO_STRING into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: RPPN
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM RP_OPTIONS_INTO_STRING - RP OPTIONS INTO STRING

CALL FUNCTION 'RP_OPTIONS_INTO_STRING' "
  EXPORTING
*   max_chosen_number = 0       " sy-index      Maximum number of selectable options
*   delimiter_sign = '/'        "               Delimiter for string sequence
    text_title =                "               Dialog box header
*   text_left =                 "               Text for selectable options
*   text_right =                "               Text for selectable options
*   status = 'NOORDER'          "               Defines whether or not the sequence is important
*   text_object =               " dokhl-object  Text in dialog can be maintained using SE61
*   dyn_pushbutton_text1 =      "               Text for button in F key string
*   dyn_pushbutton_text2 =      "               Text for button in F key string
*   dyn_pushbutton_text3 =      "               Text for button in F key string
  IMPORTING
    return_code =               " sy-subrc      Defines which button terminated the dialog
  TABLES
    text_symbol_relation_tab =   " pnpstringt   Table of possible options and their ID codes
  CHANGING
    string_value =              "               Represents the selected options
  EXCEPTIONS
    TABLE_STRING_INCONSISTENCY = 1  "           String does not match table
    UNKNOWN_STATUS = 2          "               Status not 'ORDER' / 'NOORDER'
    STRING_VALUE_OVERFLOW = 3   "
    .  "  RP_OPTIONS_INTO_STRING

ABAP code example for Function Module RP_OPTIONS_INTO_STRING

The ABAP code below is a full code listing to execute function module RP_OPTIONS_INTO_STRING including all data declarations. The code uses the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the original method of declaring data variables up front. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8).

DATA:
ld_return_code  
 
 TYPE SY-SUBRC
,
it_text_symbol_relation_tab  
 
 TYPE STANDARD TABLE OF PNPSTRINGT,"TABLES PARAM
wa_text_symbol_relation_tab
 
 LIKE LINE OF it_text_symbol_relation_tab
.


DATA(ld_string_value) = 'some text here'.

DATA(ld_max_chosen_number) = '123 '.

DATA(ld_delimiter_sign) = 'some text here'.

DATA(ld_text_title) = 'some text here'.

DATA(ld_text_left) = 'some text here'.

DATA(ld_text_right) = 'some text here'.

DATA(ld_status) = 'some text here'.
 

SELECT single OBJECT 
  FROM DOKHL 
  INTO @DATA(ld_text_object).


DATA(ld_dyn_pushbutton_text1) = 'some text here'.

DATA(ld_dyn_pushbutton_text2) = 'some text here'.

DATA(ld_dyn_pushbutton_text3) = 'some text here'.
 

"populate fields of struture and append to itab
append wa_text_symbol_relation_tab to it_text_symbol_relation_tab.
.

CALL FUNCTION 'RP_OPTIONS_INTO_STRING'
  EXPORTING
*   max_chosen_number =          ld_max_chosen_number
*   delimiter_sign =             ld_delimiter_sign
    text_title =                 ld_text_title
*   text_left =                  ld_text_left
*   text_right =                 ld_text_right
*   status =                     ld_status
*   text_object =                ld_text_object
*   dyn_pushbutton_text1 =       ld_dyn_pushbutton_text1
*   dyn_pushbutton_text2 =       ld_dyn_pushbutton_text2
*   dyn_pushbutton_text3 =       ld_dyn_pushbutton_text3
  IMPORTING
    return_code =                ld_return_code
  TABLES
    text_symbol_relation_tab =    it_text_symbol_relation_tab
  CHANGING
    string_value =               ld_string_value
  EXCEPTIONS
    TABLE_STRING_INCONSISTENCY =    1
    UNKNOWN_STATUS =             2
    STRING_VALUE_OVERFLOW =      3
    .  "  RP_OPTIONS_INTO_STRING

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_string_value
 
 TYPE STRING ,
ld_return_code
 
 TYPE SY-SUBRC ,
ld_max_chosen_number
 
 TYPE SY-INDEX ,
it_text_symbol_relation_tab
 
 TYPE STANDARD TABLE OF PNPSTRINGT ,
wa_text_symbol_relation_tab
 
 LIKE LINE OF it_text_symbol_relation_tab,
ld_delimiter_sign
 
 TYPE STRING ,
ld_text_title
 
 TYPE STRING ,
ld_text_left
 
 TYPE STRING ,
ld_text_right
 
 TYPE STRING ,
ld_status
 
 TYPE STRING ,
ld_text_object
 
 TYPE DOKHL-OBJECT ,
ld_dyn_pushbutton_text1
 
 TYPE STRING ,
ld_dyn_pushbutton_text2
 
 TYPE STRING ,
ld_dyn_pushbutton_text3
 
 TYPE STRING .


ld_string_value = 'some text here'.
ld_max_chosen_number = '123 '. 

"populate fields of struture and append to itab
append wa_text_symbol_relation_tab to it_text_symbol_relation_tab.
ld_delimiter_sign = 'some text here'.
ld_text_title = 'some text here'.
ld_text_left = 'some text here'.
ld_text_right = 'some text here'.
ld_status = 'some text here'.

SELECT single OBJECT 
  FROM DOKHL 
  INTO ld_text_object.

ld_dyn_pushbutton_text1 = 'some text here'.
ld_dyn_pushbutton_text2 = 'some text here'.
ld_dyn_pushbutton_text3 = 'some text here'.

SAP Documentation for FM RP_OPTIONS_INTO_STRING