SAP CMS_API_STATUS_GET_UI_TEXT Function Module for Get the status(system and user status) text









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

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



Function CMS_API_STATUS_GET_UI_TEXT 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 'CMS_API_STATUS_GET_UI_TEXT'"Get the status(system and user status) text
EXPORTING
I_OBJECT_ID = "Object Identification number
* I_FLG_USR_STAT = 'X' "Indicator
* I_FLG_ONLY_ACTIVE = 'X' "Indicator
* I_LANGU = SY-LANGU "SAP System, current language

IMPORTING
E_SYS_STAT_LINE = "System status
E_USR_STAT_LINE = "User Status
E_TAB_RC = "Return Code and corresponding Message
.



IMPORTING Parameters details for CMS_API_STATUS_GET_UI_TEXT

I_OBJECT_ID - Object Identification number

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

I_FLG_USR_STAT - Indicator

Data type: CMS_DTE_FLG
Default: 'X'
Optional: Yes
Call by Reference: Yes

I_FLG_ONLY_ACTIVE - Indicator

Data type: CMS_DTE_FLG
Default: 'X'
Optional: Yes
Call by Reference: Yes

I_LANGU - SAP System, current language

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

EXPORTING Parameters details for CMS_API_STATUS_GET_UI_TEXT

E_SYS_STAT_LINE - System status

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

E_USR_STAT_LINE - User Status

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

E_TAB_RC - Return Code and corresponding Message

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

Copy and paste ABAP code example for CMS_API_STATUS_GET_UI_TEXT 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 CMS_DTE_OBJECT_ID, "   
lv_e_sys_stat_line  TYPE CMS_DTE_SYS_STAT_LINE, "   
lv_i_flg_usr_stat  TYPE CMS_DTE_FLG, "   'X'
lv_e_usr_stat_line  TYPE CMS_DTE_USR_STAT_LINE, "   
lv_e_tab_rc  TYPE CMS_TAB_MSG_COL_MESSAGE, "   
lv_i_flg_only_active  TYPE CMS_DTE_FLG, "   'X'
lv_i_langu  TYPE SY-LANGU. "   SY-LANGU

  CALL FUNCTION 'CMS_API_STATUS_GET_UI_TEXT'  "Get the status(system and user status) text
    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_TAB_RC = lv_e_tab_rc
. " CMS_API_STATUS_GET_UI_TEXT




ABAP code using 7.40 inline data declarations to call FM CMS_API_STATUS_GET_UI_TEXT

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!