ENQUEUE_E_SSUBTXTDEF SAP Function module - Request lock for object E_SSUBTXTDEF

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

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

Pattern for FM ENQUEUE_E_SSUBTXTDEF - ENQUEUE E SSUBTXTDEF

CALL FUNCTION 'ENQUEUE_E_SSUBTXTDEF' "Request lock for object E_SSUBTXTDEF
* EXPORTING
*   mode_ssubtxtdef = 'E'       " enqmode       Lock mode for table SSUBTXTDEF
*   mandt = SY-MANDT            " ssubtxtdef-mandt  01th enqueue argument
*   typeidobj =                 " ssubtxtdef-typeidobj  02th enqueue argument
*   catidobj =                  " ssubtxtdef-catidobj  03th enqueue argument
*   event =                     " ssubtxtdef-event  04th enqueue argument
*   x_typeidobj = SPACE         "               Fill argument 02 with initial value?
*   x_catidobj = SPACE          "               Fill argument 03 with initial value?
*   x_event = SPACE             "               Fill argument 04 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_SSUBTXTDEF

ABAP code example for Function Module ENQUEUE_E_SSUBTXTDEF

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

SELECT single MANDT 
  FROM SSUBTXTDEF 
  INTO @DATA(ld_mandt).

 

SELECT single TYPEIDOBJ 
  FROM SSUBTXTDEF 
  INTO @DATA(ld_typeidobj).

 

SELECT single CATIDOBJ 
  FROM SSUBTXTDEF 
  INTO @DATA(ld_catidobj).

 

SELECT single EVENT 
  FROM SSUBTXTDEF 
  INTO @DATA(ld_event).


DATA(ld_x_typeidobj) = 'some text here'.

DATA(ld_x_catidobj) = 'some text here'.

DATA(ld_x_event) = '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_SSUBTXTDEF'
* EXPORTING
*   mode_ssubtxtdef =            ld_mode_ssubtxtdef
*   mandt =                      ld_mandt
*   typeidobj =                  ld_typeidobj
*   catidobj =                   ld_catidobj
*   event =                      ld_event
*   x_typeidobj =                ld_x_typeidobj
*   x_catidobj =                 ld_x_catidobj
*   x_event =                    ld_x_event
*   _scope =                     ld__scope
*   _wait =                      ld__wait
*   _collect =                   ld__collect
  EXCEPTIONS
    FOREIGN_LOCK =               1
    SYSTEM_FAILURE =             2
    .  "  ENQUEUE_E_SSUBTXTDEF

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_ssubtxtdef
 
 TYPE ENQMODE ,
ld_mandt
 
 TYPE SSUBTXTDEF-MANDT ,
ld_typeidobj
 
 TYPE SSUBTXTDEF-TYPEIDOBJ ,
ld_catidobj
 
 TYPE SSUBTXTDEF-CATIDOBJ ,
ld_event
 
 TYPE SSUBTXTDEF-EVENT ,
ld_x_typeidobj
 
 TYPE STRING ,
ld_x_catidobj
 
 TYPE STRING ,
ld_x_event
 
 TYPE STRING ,
ld__scope
 
 TYPE STRING ,
ld__wait
 
 TYPE STRING ,
ld__collect
 
 TYPE DDENQCOLL .


ld_mode_ssubtxtdef = 'Check type of data required'.

SELECT single MANDT 
  FROM SSUBTXTDEF 
  INTO ld_mandt.


SELECT single TYPEIDOBJ 
  FROM SSUBTXTDEF 
  INTO ld_typeidobj.


SELECT single CATIDOBJ 
  FROM SSUBTXTDEF 
  INTO ld_catidobj.


SELECT single EVENT 
  FROM SSUBTXTDEF 
  INTO ld_event.

ld_x_typeidobj = 'some text here'.
ld_x_catidobj = 'some text here'.
ld_x_event = 'some text here'.
ld__scope = 'some text here'.
ld__wait = 'some text here'.
ld__collect = 'Check type of data required'.