SAP ENQUEUE_ESSCOOKIE Function Module for Request lock for object ESSCOOKIE









ENQUEUE_ESSCOOKIE is a standard enqueue esscookie 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 ESSCOOKIE 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 esscookie FM, simply by entering the name ENQUEUE_ESSCOOKIE into the relevant SAP transaction such as SE37 or SE38.

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



Function ENQUEUE_ESSCOOKIE 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_ESSCOOKIE'"Request lock for object ESSCOOKIE
EXPORTING
* MODE_SSCOOKIEID = 'X' "Lock mode for table SSCOOKIEID
* SID = "01th enqueue argument
* X_SID = ' ' "Fill argument 01 with initial value?
* _SCOPE = '2' "
* _WAIT = ' ' "
* _COLLECT = ' ' "Initially only collect lock

EXCEPTIONS
FOREIGN_LOCK = 1 SYSTEM_FAILURE = 2
.



IMPORTING Parameters details for ENQUEUE_ESSCOOKIE

MODE_SSCOOKIEID - Lock mode for table SSCOOKIEID

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

SID - 01th enqueue argument

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

X_SID - Fill argument 01 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_ESSCOOKIE 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_sscookieid  TYPE ENQMODE, "   'X'
lv_sid  TYPE SSCOOKIEID-SID, "   
lv_system_failure  TYPE SSCOOKIEID, "   
lv_x_sid  TYPE SSCOOKIEID, "   SPACE
lv__scope  TYPE SSCOOKIEID, "   '2'
lv__wait  TYPE SSCOOKIEID, "   SPACE
lv__collect  TYPE DDENQCOLL. "   ' '

  CALL FUNCTION 'ENQUEUE_ESSCOOKIE'  "Request lock for object ESSCOOKIE
    EXPORTING
         MODE_SSCOOKIEID = lv_mode_sscookieid
         SID = lv_sid
         X_SID = lv_x_sid
         _SCOPE = lv__scope
         _WAIT = lv__wait
         _COLLECT = lv__collect
    EXCEPTIONS
        FOREIGN_LOCK = 1
        SYSTEM_FAILURE = 2
. " ENQUEUE_ESSCOOKIE




ABAP code using 7.40 inline data declarations to call FM ENQUEUE_ESSCOOKIE

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_sscookieid) = 'X'.
 
"SELECT single SID FROM SSCOOKIEID INTO @DATA(ld_sid).
 
 
DATA(ld_x_sid) = ' '.
 
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!