SAP ENQUEUE_READ Function Module for Read lock entries from lock table









ENQUEUE_READ is a standard enqueue read SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read lock entries from lock table 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 read FM, simply by entering the name ENQUEUE_READ into the relevant SAP transaction such as SE37 or SE38.

Function Group: SENT
Program Name: SAPLSENT
Main Program: SAPLSENT
Appliation area: S
Release date: 10-Nov-1994
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function ENQUEUE_READ 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_READ'"Read lock entries from lock table
EXPORTING
* GCLIENT = SY-MANDT "Client
* GNAME = ' ' "Granularity name (-> table name)
* GARG = ' ' "Granularity value(->values of key fields)
* GUNAME = SY-UNAME "User Name
* LOCAL = ' ' "Single-Character Flag
* FAST = ' ' "Redundant table fields are not fully filled
* GARGNOWC = ' ' "All characters in GARG are literals

IMPORTING
NUMBER = "Number of chosen lock entries
SUBRC = "Error code of the enqueue call

TABLES
ENQ = "List of the chosen lock entries

EXCEPTIONS
COMMUNICATION_FAILURE = 1 SYSTEM_FAILURE = 2
.



IMPORTING Parameters details for ENQUEUE_READ

GCLIENT - Client

Data type: SEQG3-GCLIENT
Default: SY-MANDT
Optional: Yes
Call by Reference: No ( called with pass by value option)

GNAME - Granularity name (-> table name)

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

GARG - Granularity value(->values of key fields)

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

GUNAME - User Name

Data type: SEQG3-GUNAME
Default: SY-UNAME
Optional: Yes
Call by Reference: No ( called with pass by value option)

LOCAL - Single-Character Flag

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

FAST - Redundant table fields are not fully filled

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

GARGNOWC - All characters in GARG are literals

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

EXPORTING Parameters details for ENQUEUE_READ

NUMBER - Number of chosen lock entries

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

SUBRC - Error code of the enqueue call

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

TABLES Parameters details for ENQUEUE_READ

ENQ - List of the chosen lock entries

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

EXCEPTIONS details

COMMUNICATION_FAILURE - See RFC documentation

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

SYSTEM_FAILURE - See RFC documentation

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

Copy and paste ABAP code example for ENQUEUE_READ 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:
lt_enq  TYPE STANDARD TABLE OF SEQG3, "   
lv_number  TYPE SY-TABIX, "   
lv_gclient  TYPE SEQG3-GCLIENT, "   SY-MANDT
lv_communication_failure  TYPE SEQG3, "   
lv_gname  TYPE SEQG3-GNAME, "   SPACE
lv_subrc  TYPE SY-SUBRC, "   
lv_system_failure  TYPE SY, "   
lv_garg  TYPE SEQG3-GARG, "   SPACE
lv_guname  TYPE SEQG3-GUNAME, "   SY-UNAME
lv_local  TYPE SY-CTYPE, "   SPACE
lv_fast  TYPE SY-CTYPE, "   SPACE
lv_gargnowc  TYPE SY-CTYPE. "   SPACE

  CALL FUNCTION 'ENQUEUE_READ'  "Read lock entries from lock table
    EXPORTING
         GCLIENT = lv_gclient
         GNAME = lv_gname
         GARG = lv_garg
         GUNAME = lv_guname
         LOCAL = lv_local
         FAST = lv_fast
         GARGNOWC = lv_gargnowc
    IMPORTING
         NUMBER = lv_number
         SUBRC = lv_subrc
    TABLES
         ENQ = lt_enq
    EXCEPTIONS
        COMMUNICATION_FAILURE = 1
        SYSTEM_FAILURE = 2
. " ENQUEUE_READ




ABAP code using 7.40 inline data declarations to call FM ENQUEUE_READ

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.

 
"SELECT single TABIX FROM SY INTO @DATA(ld_number).
 
"SELECT single GCLIENT FROM SEQG3 INTO @DATA(ld_gclient).
DATA(ld_gclient) = SY-MANDT.
 
 
"SELECT single GNAME FROM SEQG3 INTO @DATA(ld_gname).
DATA(ld_gname) = ' '.
 
"SELECT single SUBRC FROM SY INTO @DATA(ld_subrc).
 
 
"SELECT single GARG FROM SEQG3 INTO @DATA(ld_garg).
DATA(ld_garg) = ' '.
 
"SELECT single GUNAME FROM SEQG3 INTO @DATA(ld_guname).
DATA(ld_guname) = SY-UNAME.
 
"SELECT single CTYPE FROM SY INTO @DATA(ld_local).
DATA(ld_local) = ' '.
 
"SELECT single CTYPE FROM SY INTO @DATA(ld_fast).
DATA(ld_fast) = ' '.
 
"SELECT single CTYPE FROM SY INTO @DATA(ld_gargnowc).
DATA(ld_gargnowc) = ' '.
 


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!