SAP DEQUEUE_/AIN/UI_DOC Function Module for Release lock on object /AIN/UI_DOC









DEQUEUE_/AIN/UI_DOC is a standard dequeue /ain/ui doc SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Release lock on object /AIN/UI_DOC 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 dequeue /ain/ui doc FM, simply by entering the name DEQUEUE_/AIN/UI_DOC into the relevant SAP transaction such as SE37 or SE38.

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



Function DEQUEUE_/AIN/UI_DOC 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 'DEQUEUE_/AIN/UI_DOC'"Release lock on object /AIN/UI_DOC
EXPORTING
* MODE_/AIN/DM_DOC = 'E' "Lock mode for table /AIN/DM_DOC
* CLIENT = SY-MANDT "01th enqueue argument
* DOC_GUID = "02th enqueue argument
* X_DOC_GUID = ' ' "Fill argument 02 with initial value?
* _SCOPE = '3' "
* _SYNCHRON = ' ' "Synchonous unlock
* _COLLECT = ' ' "Initially only collect lock
.



IMPORTING Parameters details for DEQUEUE_/AIN/UI_DOC

MODE_/AIN/DM_DOC - Lock mode for table /AIN/DM_DOC

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

CLIENT - 01th enqueue argument

Data type: /AIN/DM_DOC-CLIENT
Default: SY-MANDT
Optional: Yes
Call by Reference: No ( called with pass by value option)

DOC_GUID - 02th enqueue argument

Data type: /AIN/DM_DOC-DOC_GUID
Optional: Yes
Call by Reference: No ( called with pass by value option)

X_DOC_GUID - 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: '3'
Optional: Yes
Call by Reference: No ( called with pass by value option)

_SYNCHRON - Synchonous unlock

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)

Copy and paste ABAP code example for DEQUEUE_/AIN/UI_DOC 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_mode_/ain/dm_doc  TYPE ENQMODE, "   'E'
lv_client  TYPE /AIN/DM_DOC-CLIENT, "   SY-MANDT
lv_doc_guid  TYPE /AIN/DM_DOC-DOC_GUID, "   
lv_x_doc_guid  TYPE /AIN/DM_DOC, "   SPACE
lv__scope  TYPE /AIN/DM_DOC, "   '3'
lv__synchron  TYPE /AIN/DM_DOC, "   SPACE
lv__collect  TYPE DDENQCOLL. "   ' '

  CALL FUNCTION 'DEQUEUE_/AIN/UI_DOC'  "Release lock on object /AIN/UI_DOC
    EXPORTING
         MODE_/AIN/DM_DOC = lv_mode_/ain/dm_doc
         CLIENT = lv_client
         DOC_GUID = lv_doc_guid
         X_DOC_GUID = lv_x_doc_guid
         _SCOPE = lv__scope
         _SYNCHRON = lv__synchron
         _COLLECT = lv__collect
. " DEQUEUE_/AIN/UI_DOC




ABAP code using 7.40 inline data declarations to call FM DEQUEUE_/AIN/UI_DOC

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_/ain/dm_doc) = 'E'.
 
"SELECT single CLIENT FROM /AIN/DM_DOC INTO @DATA(ld_client).
DATA(ld_client) = SY-MANDT.
 
"SELECT single DOC_GUID FROM /AIN/DM_DOC INTO @DATA(ld_doc_guid).
 
DATA(ld_x_doc_guid) = ' '.
 
DATA(ld__scope) = '3'.
 
DATA(ld__synchron) = ' '.
 
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!