OCS_API_CHECK_INACTIVE_OBJECTS SAP Function module

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

Associated Function Group: OCS_API
Released Date: Not Released
Processing type: Remote-Enabled

Pattern for FM OCS_API_CHECK_INACTIVE_OBJECTS - OCS API CHECK INACTIVE OBJECTS

CALL FUNCTION 'OCS_API_CHECK_INACTIVE_OBJECTS' "
  EXPORTING
    it_patq =                   " tt_pat_q
*   iv_logfile =                " char255
*   iv_log_dirtype = 'T'        " char1
  IMPORTING
    ev_rc =                     " int4
    ev_message =                " patchtxt3
    es_message =                " ocs_apimsg
* TABLES
*   et_inactive_objects =       " e071
    .  "  OCS_API_CHECK_INACTIVE_OBJECTS

ABAP code example for Function Module OCS_API_CHECK_INACTIVE_OBJECTS

The ABAP code below is a full code listing to execute function module OCS_API_CHECK_INACTIVE_OBJECTS 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_ev_rc  
 
 TYPE INT4
,
ld_ev_message  
 
 TYPE PATCHTXT3
,
ld_es_message  
 
 TYPE OCS_APIMSG
,
it_et_inactive_objects  
 
 TYPE STANDARD TABLE OF E071,"TABLES PARAM
wa_et_inactive_objects
 
 LIKE LINE OF it_et_inactive_objects
.


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

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

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

"populate fields of struture and append to itab
append wa_et_inactive_objects to it_et_inactive_objects.
.

CALL FUNCTION 'OCS_API_CHECK_INACTIVE_OBJECTS'
  EXPORTING
    it_patq =                    ld_it_patq
*   iv_logfile =                 ld_iv_logfile
*   iv_log_dirtype =             ld_iv_log_dirtype
  IMPORTING
    ev_rc =                      ld_ev_rc
    ev_message =                 ld_ev_message
    es_message =                 ld_es_message
* TABLES
*   et_inactive_objects =        it_et_inactive_objects
    .  "  OCS_API_CHECK_INACTIVE_OBJECTS

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_ev_rc
 
 TYPE INT4 ,
ld_it_patq
 
 TYPE TT_PAT_Q ,
it_et_inactive_objects
 
 TYPE STANDARD TABLE OF E071 ,
wa_et_inactive_objects
 
 LIKE LINE OF it_et_inactive_objects,
ld_ev_message
 
 TYPE PATCHTXT3 ,
ld_iv_logfile
 
 TYPE CHAR255 ,
ld_es_message
 
 TYPE OCS_APIMSG ,
ld_iv_log_dirtype
 
 TYPE CHAR1 .


ld_it_patq = 'Check type of data required'. 

"populate fields of struture and append to itab
append wa_et_inactive_objects to it_et_inactive_objects.
ld_iv_logfile = 'Check type of data required'.
ld_iv_log_dirtype = 'Check type of data required'.