CMS_API_STATUS_GET SAP Function module - Status get logic

CMS_API_STATUS_GET 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 CMS_API_STATUS_GET into the relevant SAP transaction such as SE37 or SE80.

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

Pattern for FM CMS_API_STATUS_GET - CMS API STATUS GET

CALL FUNCTION 'CMS_API_STATUS_GET' "Status get logic
  EXPORTING
    i_object_id =               " cms_dte_object_id  Object Identification number
*   i_flag_active = SPACE       " cms_dte_flg   Indicator
  IMPORTING
    e_stat_obj =                " j_obtyp       Object type
    e_stat_prof =               " cms_dte_pcn_stat_prof  User status profile
    e_tab_sys_stat =            " cms_tab_sys_stat  System status
    e_tab_usr_stat =            " cms_tab_usr_stat  User status
    e_tab_rc =                  " cms_tab_msg_col_message  Return Code and corresponding Message
    .  "  CMS_API_STATUS_GET

ABAP code example for Function Module CMS_API_STATUS_GET

The ABAP code below is a full code listing to execute function module CMS_API_STATUS_GET 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_e_stat_obj  
 
 TYPE J_OBTYP
,
ld_e_stat_prof  
 
 TYPE CMS_DTE_PCN_STAT_PROF
,
ld_e_tab_sys_stat  
 
 TYPE CMS_TAB_SYS_STAT
,
ld_e_tab_usr_stat  
 
 TYPE CMS_TAB_USR_STAT
,
ld_e_tab_rc  
 
 TYPE CMS_TAB_MSG_COL_MESSAGE
.


DATA(ld_i_object_id) = 'Check type of data required'.

DATA(ld_i_flag_active) = 'Check type of data required'.
.

CALL FUNCTION 'CMS_API_STATUS_GET'
  EXPORTING
    i_object_id =                ld_i_object_id
*   i_flag_active =              ld_i_flag_active
  IMPORTING
    e_stat_obj =                 ld_e_stat_obj
    e_stat_prof =                ld_e_stat_prof
    e_tab_sys_stat =             ld_e_tab_sys_stat
    e_tab_usr_stat =             ld_e_tab_usr_stat
    e_tab_rc =                   ld_e_tab_rc
    .  "  CMS_API_STATUS_GET

IF SY-SUBRC EQ 0.
  "All OK
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_e_stat_obj
 
 TYPE J_OBTYP ,
ld_i_object_id
 
 TYPE CMS_DTE_OBJECT_ID ,
ld_e_stat_prof
 
 TYPE CMS_DTE_PCN_STAT_PROF ,
ld_i_flag_active
 
 TYPE CMS_DTE_FLG ,
ld_e_tab_sys_stat
 
 TYPE CMS_TAB_SYS_STAT ,
ld_e_tab_usr_stat
 
 TYPE CMS_TAB_USR_STAT ,
ld_e_tab_rc
 
 TYPE CMS_TAB_MSG_COL_MESSAGE .


ld_i_object_id = 'Check type of data required'.
ld_i_flag_active = 'Check type of data required'.