SAP BNK_API_GET_UI_TEXT_LONG Function Module for FM to get the long text for the system and user status









BNK_API_GET_UI_TEXT_LONG is a standard bnk api get ui text long SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for FM to get the long text for the system and user status processing and below is the pattern details for this FM, 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 bnk api get ui text long FM, simply by entering the name BNK_API_GET_UI_TEXT_LONG into the relevant SAP transaction such as SE37 or SE38.

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



Function BNK_API_GET_UI_TEXT_LONG 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 'BNK_API_GET_UI_TEXT_LONG'"FM to get the long text for the system and user status
EXPORTING
I_OBJECT_ID = "GUID to identify the batch
* I_FLG_USR_STAT = 'X' "Boolean Variable
* I_FLG_ONLY_ACTIVE = 'X' "Boolean Variable
* I_LANGU = SY-LANGU "Language Key of Current Text Environment

IMPORTING
E_SYS_STAT_LINE = "System status line
E_USR_STAT_LINE = "System status line
E_SYS_STAT_LINE_LONG = "System status line
E_USR_STAT_LINE_LONG = "
E_TAB_RC = "Return parameter table
.



IMPORTING Parameters details for BNK_API_GET_UI_TEXT_LONG

I_OBJECT_ID - GUID to identify the batch

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

I_FLG_USR_STAT - Boolean Variable

Data type: BNK_COM_BOOLEAN
Default: 'X'
Optional: No
Call by Reference: Yes

I_FLG_ONLY_ACTIVE - Boolean Variable

Data type: BNK_COM_BOOLEAN
Default: 'X'
Optional: No
Call by Reference: Yes

I_LANGU - Language Key of Current Text Environment

Data type: SY-LANGU
Default: SY-LANGU
Optional: No
Call by Reference: Yes

EXPORTING Parameters details for BNK_API_GET_UI_TEXT_LONG

E_SYS_STAT_LINE - System status line

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

E_USR_STAT_LINE - System status line

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

E_SYS_STAT_LINE_LONG - System status line

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

E_USR_STAT_LINE_LONG -

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

E_TAB_RC - Return parameter table

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

Copy and paste ABAP code example for BNK_API_GET_UI_TEXT_LONG 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_i_object_id  TYPE BNK_COM_BTCH_GUID, "   
lv_e_sys_stat_line  TYPE J_STEXT, "   
lv_i_flg_usr_stat  TYPE BNK_COM_BOOLEAN, "   'X'
lv_e_usr_stat_line  TYPE J_STEXT, "   
lv_i_flg_only_active  TYPE BNK_COM_BOOLEAN, "   'X'
lv_e_sys_stat_line_long  TYPE C, "   
lv_i_langu  TYPE SY-LANGU, "   SY-LANGU
lv_e_usr_stat_line_long  TYPE C, "   
lv_e_tab_rc  TYPE BAPIRET2_T. "   

  CALL FUNCTION 'BNK_API_GET_UI_TEXT_LONG'  "FM to get the long text for the system and user status
    EXPORTING
         I_OBJECT_ID = lv_i_object_id
         I_FLG_USR_STAT = lv_i_flg_usr_stat
         I_FLG_ONLY_ACTIVE = lv_i_flg_only_active
         I_LANGU = lv_i_langu
    IMPORTING
         E_SYS_STAT_LINE = lv_e_sys_stat_line
         E_USR_STAT_LINE = lv_e_usr_stat_line
         E_SYS_STAT_LINE_LONG = lv_e_sys_stat_line_long
         E_USR_STAT_LINE_LONG = lv_e_usr_stat_line_long
         E_TAB_RC = lv_e_tab_rc
. " BNK_API_GET_UI_TEXT_LONG




ABAP code using 7.40 inline data declarations to call FM BNK_API_GET_UI_TEXT_LONG

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.

 
 
DATA(ld_i_flg_usr_stat) = 'X'.
 
 
DATA(ld_i_flg_only_active) = 'X'.
 
 
"SELECT single LANGU FROM SY INTO @DATA(ld_i_langu).
DATA(ld_i_langu) = SY-LANGU.
 
 
 


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!