ENQUEUE_E_USOBT_C SAP Function module - Request lock for object E_USOBT_C

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

Associated Function Group: DWBEN/SAPLSEN0000
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM ENQUEUE_E_USOBT_C - ENQUEUE E USOBT C

CALL FUNCTION 'ENQUEUE_E_USOBT_C' "Request lock for object E_USOBT_C
* EXPORTING
*   mode_usobt_c = 'E'          " enqmode       Lock mode for table USOBT_C
*   name =                      " usobt_c-name  01th enqueue argument
*   type =                      " usobt_c-type  02th enqueue argument
*   object =                    " usobt_c-object  03th enqueue argument
*   field =                     " usobt_c-field  04th enqueue argument
*   low =                       " usobt_c-low   05th enqueue argument
*   x_name = SPACE              "               Fill argument 01 with initial value?
*   x_type = SPACE              "               Fill argument 02 with initial value?
*   x_object = SPACE            "               Fill argument 03 with initial value?
*   x_field = SPACE             "               Fill argument 04 with initial value?
*   x_low = SPACE               "               Fill argument 05 with initial value?
*   _scope = '2'                "
*   _wait = SPACE               "
*   _collect = ' '              " ddenqcoll     Initially only collect lock
  EXCEPTIONS
    FOREIGN_LOCK = 1            "               Object already locked
    SYSTEM_FAILURE = 2          "               Internal error from enqueue server
    .  "  ENQUEUE_E_USOBT_C

ABAP code example for Function Module ENQUEUE_E_USOBT_C

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

SELECT single NAME 
  FROM USOBT_C 
  INTO @DATA(ld_name).

 

SELECT single TYPE 
  FROM USOBT_C 
  INTO @DATA(ld_type).

 

SELECT single OBJECT 
  FROM USOBT_C 
  INTO @DATA(ld_object).

 

SELECT single FIELD 
  FROM USOBT_C 
  INTO @DATA(ld_field).

 

SELECT single LOW 
  FROM USOBT_C 
  INTO @DATA(ld_low).


DATA(ld_x_name) = 'some text here'.

DATA(ld_x_type) = 'some text here'.

DATA(ld_x_object) = 'some text here'.

DATA(ld_x_field) = 'some text here'.

DATA(ld_x_low) = 'some text here'.

DATA(ld__scope) = 'some text here'.

DATA(ld__wait) = 'some text here'.

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

CALL FUNCTION 'ENQUEUE_E_USOBT_C'
* EXPORTING
*   mode_usobt_c =               ld_mode_usobt_c
*   name =                       ld_name
*   type =                       ld_type
*   object =                     ld_object
*   field =                      ld_field
*   low =                        ld_low
*   x_name =                     ld_x_name
*   x_type =                     ld_x_type
*   x_object =                   ld_x_object
*   x_field =                    ld_x_field
*   x_low =                      ld_x_low
*   _scope =                     ld__scope
*   _wait =                      ld__wait
*   _collect =                   ld__collect
  EXCEPTIONS
    FOREIGN_LOCK =               1
    SYSTEM_FAILURE =             2
    .  "  ENQUEUE_E_USOBT_C

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "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_mode_usobt_c
 
 TYPE ENQMODE ,
ld_name
 
 TYPE USOBT_C-NAME ,
ld_type
 
 TYPE USOBT_C-TYPE ,
ld_object
 
 TYPE USOBT_C-OBJECT ,
ld_field
 
 TYPE USOBT_C-FIELD ,
ld_low
 
 TYPE USOBT_C-LOW ,
ld_x_name
 
 TYPE STRING ,
ld_x_type
 
 TYPE STRING ,
ld_x_object
 
 TYPE STRING ,
ld_x_field
 
 TYPE STRING ,
ld_x_low
 
 TYPE STRING ,
ld__scope
 
 TYPE STRING ,
ld__wait
 
 TYPE STRING ,
ld__collect
 
 TYPE DDENQCOLL .


ld_mode_usobt_c = 'Check type of data required'.

SELECT single NAME 
  FROM USOBT_C 
  INTO ld_name.


SELECT single TYPE 
  FROM USOBT_C 
  INTO ld_type.


SELECT single OBJECT 
  FROM USOBT_C 
  INTO ld_object.


SELECT single FIELD 
  FROM USOBT_C 
  INTO ld_field.


SELECT single LOW 
  FROM USOBT_C 
  INTO ld_low.

ld_x_name = 'some text here'.
ld_x_type = 'some text here'.
ld_x_object = 'some text here'.
ld_x_field = 'some text here'.
ld_x_low = 'some text here'.
ld__scope = 'some text here'.
ld__wait = 'some text here'.
ld__collect = 'Check type of data required'.