SAP OCS_DISPLAY_WITH_USER_BUTTON Function Module for









OCS_DISPLAY_WITH_USER_BUTTON is a standard ocs display with user button SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for ocs display with user button FM, simply by entering the name OCS_DISPLAY_WITH_USER_BUTTON into the relevant SAP transaction such as SE37 or SE38.

Function Group: OCS_UI
Program Name: SAPLOCS_UI
Main Program: SAPLOCS_UI
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function OCS_DISPLAY_WITH_USER_BUTTON pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'OCS_DISPLAY_WITH_USER_BUTTON'"
  EXPORTING
*  LANGUAGE = SY-LANGU "Text document language key
   POPUP_TITLE =  "Text of title line
*  START_COLUMN = 5 "Start column of the dialog box
*  START_ROW = 5 "Start line of the dialog box
*  DOCU_CLASS = 'DT' "Document Class
   TEXT_OBJECT =  "Name of the text document
*  DISPLAY_OK_BUTTON = 'X' "OK button display switch
*  DISPLAY_CANCEL_BUTTON = 'X' "Cancel button display switch

 IMPORTING
   ANSWER =  "OK Code

TABLES
*  USER_BUTTONS =  "Pushbutton transfer table
   PARAMETER =  "Interface for function group SP06

EXCEPTIONS
   ERROR_IN_TEXT = 1    TEXT_NOT_FOUND = 2
.



IMPORTING Parameters details for OCS_DISPLAY_WITH_USER_BUTTON

LANGUAGE - Text document language key

Data type: SY-LANGU
Default: SY-LANGU
Optional: Yes
Call by Reference: No ( called with pass by value option)

POPUP_TITLE - Text of title line

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

START_COLUMN - Start column of the dialog box

Data type: SY-CUCOL
Default: 5
Optional: Yes
Call by Reference: No ( called with pass by value option)

START_ROW - Start line of the dialog box

Data type: SY-CUROW
Default: 5
Optional: Yes
Call by Reference: No ( called with pass by value option)

DOCU_CLASS - Document Class

Data type: DOKIL-ID
Default: 'DT'
Optional: Yes
Call by Reference: No ( called with pass by value option)

TEXT_OBJECT - Name of the text document

Data type: DOKHL-OBJECT
Optional: No
Call by Reference: No ( called with pass by value option)

DISPLAY_OK_BUTTON - OK button display switch

Data type:
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

DISPLAY_CANCEL_BUTTON - Cancel button display switch

Data type:
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for OCS_DISPLAY_WITH_USER_BUTTON

ANSWER - OK Code

Data type: RSNEWLENG-FCODE
Optional: No
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for OCS_DISPLAY_WITH_USER_BUTTON

USER_BUTTONS - Pushbutton transfer table

Data type: SMP_DYNTXT
Optional: Yes
Call by Reference: Yes

PARAMETER - Interface for function group SP06

Data type: SPAR
Optional: No
Call by Reference: Yes

EXCEPTIONS details

ERROR_IN_TEXT - Parameters not restricted correctly in text

Data type:
Optional: No
Call by Reference: Yes

TEXT_NOT_FOUND - Document Not Found

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for OCS_DISPLAY_WITH_USER_BUTTON Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than 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 newer method of declaring data variables on the fly. 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), which i why i have stuck to the origianl for this example.

DATA:
lv_answer  TYPE RSNEWLENG-FCODE, "   
lv_language  TYPE SY-LANGU, "   SY-LANGU
lt_user_buttons  TYPE STANDARD TABLE OF SMP_DYNTXT, "   
lv_error_in_text  TYPE SMP_DYNTXT, "   
lt_parameter  TYPE STANDARD TABLE OF SPAR, "   
lv_popup_title  TYPE SPAR, "   
lv_text_not_found  TYPE SPAR, "   
lv_start_column  TYPE SY-CUCOL, "   5
lv_start_row  TYPE SY-CUROW, "   5
lv_docu_class  TYPE DOKIL-ID, "   'DT'
lv_text_object  TYPE DOKHL-OBJECT, "   
lv_display_ok_button  TYPE DOKHL, "   'X'
lv_display_cancel_button  TYPE DOKHL. "   'X'

  CALL FUNCTION 'OCS_DISPLAY_WITH_USER_BUTTON'  "
    EXPORTING
         LANGUAGE = lv_language
         POPUP_TITLE = lv_popup_title
         START_COLUMN = lv_start_column
         START_ROW = lv_start_row
         DOCU_CLASS = lv_docu_class
         TEXT_OBJECT = lv_text_object
         DISPLAY_OK_BUTTON = lv_display_ok_button
         DISPLAY_CANCEL_BUTTON = lv_display_cancel_button
    IMPORTING
         ANSWER = lv_answer
    TABLES
         USER_BUTTONS = lt_user_buttons
         PARAMETER = lt_parameter
    EXCEPTIONS
        ERROR_IN_TEXT = 1
        TEXT_NOT_FOUND = 2
. " OCS_DISPLAY_WITH_USER_BUTTON




ABAP code using 7.40 inline data declarations to call FM OCS_DISPLAY_WITH_USER_BUTTON

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

"SELECT single FCODE FROM RSNEWLENG INTO @DATA(ld_answer).
 
"SELECT single LANGU FROM SY INTO @DATA(ld_language).
DATA(ld_language) = SY-LANGU.
 
 
 
 
 
 
"SELECT single CUCOL FROM SY INTO @DATA(ld_start_column).
DATA(ld_start_column) = 5.
 
"SELECT single CUROW FROM SY INTO @DATA(ld_start_row).
DATA(ld_start_row) = 5.
 
"SELECT single ID FROM DOKIL INTO @DATA(ld_docu_class).
DATA(ld_docu_class) = 'DT'.
 
"SELECT single OBJECT FROM DOKHL INTO @DATA(ld_text_object).
 
DATA(ld_display_ok_button) = 'X'.
 
DATA(ld_display_cancel_button) = 'X'.
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!