RSAR_INFOSOURCE_ENQUEUE SAP Function module - Locks an InfoSource with all dependent objects

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

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

Pattern for FM RSAR_INFOSOURCE_ENQUEUE - RSAR INFOSOURCE ENQUEUE

CALL FUNCTION 'RSAR_INFOSOURCE_ENQUEUE' "Locks an InfoSource with all dependent objects
  EXPORTING
    i_object =                  " rsa_object    Name of the InfoSource to be locked
    i_type =                    " rs_char1      Type of InfoSource to be locked
*   i_mode = 'E'                " rs_char1      Lock Mode
*   i_wait =                    " rs_char1      Flag: waiting for release
  EXCEPTIONS
    OBJECT_LOCKED = 1           "               The InfoSource is locked
    .  "  RSAR_INFOSOURCE_ENQUEUE

ABAP code example for Function Module RSAR_INFOSOURCE_ENQUEUE

The ABAP code below is a full code listing to execute function module RSAR_INFOSOURCE_ENQUEUE 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_i_object) = 'Check type of data required'.

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

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

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

CALL FUNCTION 'RSAR_INFOSOURCE_ENQUEUE'
  EXPORTING
    i_object =                   ld_i_object
    i_type =                     ld_i_type
*   i_mode =                     ld_i_mode
*   i_wait =                     ld_i_wait
  EXCEPTIONS
    OBJECT_LOCKED =              1
    .  "  RSAR_INFOSOURCE_ENQUEUE

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
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_i_object
 
 TYPE RSA_OBJECT ,
ld_i_type
 
 TYPE RS_CHAR1 ,
ld_i_mode
 
 TYPE RS_CHAR1 ,
ld_i_wait
 
 TYPE RS_CHAR1 .


ld_i_object = 'Check type of data required'.
ld_i_type = 'Check type of data required'.
ld_i_mode = 'Check type of data required'.
ld_i_wait = 'Check type of data required'.