SAP ENQUEUE_E_LCM_S_DOCLOCK Function Module for Request lock for object E_LCM_S_DOCLOCK









ENQUEUE_E_LCM_S_DOCLOCK is a standard enqueue e lcm s doclock SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Request lock for object E_LCM_S_DOCLOCK processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for enqueue e lcm s doclock FM, simply by entering the name ENQUEUE_E_LCM_S_DOCLOCK into the relevant SAP transaction such as SE37 or SE38.

Function Group: /1BCDWBEN/AEN0002
Program Name: /1BCDWBEN/SAPLAEN0002
Main Program:
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function ENQUEUE_E_LCM_S_DOCLOCK pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'ENQUEUE_E_LCM_S_DOCLOCK'"Request lock for object E_LCM_S_DOCLOCK
  EXPORTING
*  MODE_LCM_S_DOCUMENT_LOCKING = 'E' "Lock mode for table LCM_S_DOCUMENT_LOCKING
*  OBJECTTYPE =  "01th enqueue argument
*  OBJECTKEY =  "02th enqueue argument
*  X_OBJECTTYPE = ' ' "Fill argument 01 with initial value?
*  X_OBJECTKEY = ' ' "Fill argument 02 with initial value?
*  _SCOPE = '2' "
*  _WAIT = ' ' "
*  _COLLECT = ' ' "Initially only collect lock

EXCEPTIONS
   FOREIGN_LOCK = 1    SYSTEM_FAILURE = 2
.



IMPORTING Parameters details for ENQUEUE_E_LCM_S_DOCLOCK

MODE_LCM_S_DOCUMENT_LOCKING - Lock mode for table LCM_S_DOCUMENT_LOCKING

Data type: ENQMODE
Default: 'E'
Optional: Yes
Call by Reference: No ( called with pass by value option)

OBJECTTYPE - 01th enqueue argument

Data type: LCM_S_DOCUMENT_LOCKING-OBJECTTYPE
Optional: Yes
Call by Reference: No ( called with pass by value option)

OBJECTKEY - 02th enqueue argument

Data type: LCM_S_DOCUMENT_LOCKING-OBJECTKEY
Optional: Yes
Call by Reference: No ( called with pass by value option)

X_OBJECTTYPE - Fill argument 01 with initial value?

Data type:
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

X_OBJECTKEY - Fill argument 02 with initial value?

Data type:
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

_SCOPE -

Data type:
Default: '2'
Optional: Yes
Call by Reference: No ( called with pass by value option)

_WAIT -

Data type:
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

_COLLECT - Initially only collect lock

Data type: DDENQCOLL
Default: ' '
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXCEPTIONS details

FOREIGN_LOCK - Object already locked

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

SYSTEM_FAILURE - Internal error from enqueue server

Data type:
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for ENQUEUE_E_LCM_S_DOCLOCK Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than 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 newer method of declaring data variables on the fly. 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), which i why i have stuck to the origianl for this example.

DATA:
lv_foreign_lock  TYPE STRING, "   
lv_mode_lcm_s_document_locking  TYPE ENQMODE, "   'E'
lv_objecttype  TYPE LCM_S_DOCUMENT_LOCKING-OBJECTTYPE, "   
lv_system_failure  TYPE LCM_S_DOCUMENT_LOCKING, "   
lv_objectkey  TYPE LCM_S_DOCUMENT_LOCKING-OBJECTKEY, "   
lv_x_objecttype  TYPE LCM_S_DOCUMENT_LOCKING, "   SPACE
lv_x_objectkey  TYPE LCM_S_DOCUMENT_LOCKING, "   SPACE
lv__scope  TYPE LCM_S_DOCUMENT_LOCKING, "   '2'
lv__wait  TYPE LCM_S_DOCUMENT_LOCKING, "   SPACE
lv__collect  TYPE DDENQCOLL. "   ' '

  CALL FUNCTION 'ENQUEUE_E_LCM_S_DOCLOCK'  "Request lock for object E_LCM_S_DOCLOCK
    EXPORTING
         MODE_LCM_S_DOCUMENT_LOCKING = lv_mode_lcm_s_document_locking
         OBJECTTYPE = lv_objecttype
         OBJECTKEY = lv_objectkey
         X_OBJECTTYPE = lv_x_objecttype
         X_OBJECTKEY = lv_x_objectkey
         _SCOPE = lv__scope
         _WAIT = lv__wait
         _COLLECT = lv__collect
    EXCEPTIONS
        FOREIGN_LOCK = 1
        SYSTEM_FAILURE = 2
. " ENQUEUE_E_LCM_S_DOCLOCK




ABAP code using 7.40 inline data declarations to call FM ENQUEUE_E_LCM_S_DOCLOCK

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

 
DATA(ld_mode_lcm_s_document_locking) = 'E'.
 
"SELECT single OBJECTTYPE FROM LCM_S_DOCUMENT_LOCKING INTO @DATA(ld_objecttype).
 
 
"SELECT single OBJECTKEY FROM LCM_S_DOCUMENT_LOCKING INTO @DATA(ld_objectkey).
 
DATA(ld_x_objecttype) = ' '.
 
DATA(ld_x_objectkey) = ' '.
 
DATA(ld__scope) = '2'.
 
DATA(ld__wait) = ' '.
 
DATA(ld__collect) = ' '.
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!