SAP OIRE_VIRTUAL_LOCK_HANDLING Function Module for Handles the virtual locks of the DTF









OIRE_VIRTUAL_LOCK_HANDLING is a standard oire virtual lock handling SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Handles the virtual locks of the DTF 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 oire virtual lock handling FM, simply by entering the name OIRE_VIRTUAL_LOCK_HANDLING into the relevant SAP transaction such as SE37 or SE38.

Function Group: OIRE_PC_DTF
Program Name: SAPLOIRE_PC_DTF
Main Program: SAPLOIRE_PC_DTF
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function OIRE_VIRTUAL_LOCK_HANDLING 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 'OIRE_VIRTUAL_LOCK_HANDLING'"Handles the virtual locks of the DTF
  EXPORTING
*  I_LOCK_HANDLER = 'S' "
*  I_PROCDEF = 'CC01' "DTF: Process definition
   I_LOCKOBJ =  "Lockobject (CH or PBLNR) for the virt. DTF locking
*  I_LOCKMODE = 'E' "lock mode for table lock type
*  I_SUBOBJECT = 'CHOB' "SSR object type

EXCEPTIONS
   OBJECT_ALREADY_LOCKED = 1    OBJECT_NOT_LOCKED = 2    OBJECT_DOES_NOT_EXIST = 3    WRONG_LOCK_HANDLER = 4    WRONG_PROCDEF = 5    WRONG_SUBOBJ = 6
.



IMPORTING Parameters details for OIRE_VIRTUAL_LOCK_HANDLING

I_LOCK_HANDLER -

Data type:
Default: 'S'
Optional: No
Call by Reference: Yes

I_PROCDEF - DTF: Process definition

Data type: OIRE_DTF_LOCK-PROCDEF
Default: 'CC01'
Optional: No
Call by Reference: Yes

I_LOCKOBJ - Lockobject (CH or PBLNR) for the virt. DTF locking

Data type: OIRE_DTF_LOCK-LOCKOBJ
Optional: No
Call by Reference: Yes

I_LOCKMODE - lock mode for table lock type

Data type: DD26E-ENQMODE
Default: 'E'
Optional: Yes
Call by Reference: Yes

I_SUBOBJECT - SSR object type

Data type: OIRAPROCDEF-OBJECT_TYPE
Default: 'CHOB'
Optional: Yes
Call by Reference: Yes

EXCEPTIONS details

OBJECT_ALREADY_LOCKED - Object is already locked.

Data type:
Optional: No
Call by Reference: Yes

OBJECT_NOT_LOCKED - Object is not locked

Data type:
Optional: No
Call by Reference: Yes

OBJECT_DOES_NOT_EXIST - Object does not exist.

Data type:
Optional: No
Call by Reference: Yes

WRONG_LOCK_HANDLER - Wrong lock handler value passed.

Data type:
Optional: No
Call by Reference: Yes

WRONG_PROCDEF - Wrong process definition passed

Data type:
Optional: No
Call by Reference: Yes

WRONG_SUBOBJ - Wrong SSR object type (PBL,CHCB,CHCC,..)

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for OIRE_VIRTUAL_LOCK_HANDLING 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_i_lock_handler  TYPE STRING, "   'S'
lv_object_already_locked  TYPE STRING, "   
lv_i_procdef  TYPE OIRE_DTF_LOCK-PROCDEF, "   'CC01'
lv_object_not_locked  TYPE OIRE_DTF_LOCK, "   
lv_i_lockobj  TYPE OIRE_DTF_LOCK-LOCKOBJ, "   
lv_object_does_not_exist  TYPE OIRE_DTF_LOCK, "   
lv_i_lockmode  TYPE DD26E-ENQMODE, "   'E'
lv_wrong_lock_handler  TYPE DD26E, "   
lv_i_subobject  TYPE OIRAPROCDEF-OBJECT_TYPE, "   'CHOB'
lv_wrong_procdef  TYPE OIRAPROCDEF, "   
lv_wrong_subobj  TYPE OIRAPROCDEF. "   

  CALL FUNCTION 'OIRE_VIRTUAL_LOCK_HANDLING'  "Handles the virtual locks of the DTF
    EXPORTING
         I_LOCK_HANDLER = lv_i_lock_handler
         I_PROCDEF = lv_i_procdef
         I_LOCKOBJ = lv_i_lockobj
         I_LOCKMODE = lv_i_lockmode
         I_SUBOBJECT = lv_i_subobject
    EXCEPTIONS
        OBJECT_ALREADY_LOCKED = 1
        OBJECT_NOT_LOCKED = 2
        OBJECT_DOES_NOT_EXIST = 3
        WRONG_LOCK_HANDLER = 4
        WRONG_PROCDEF = 5
        WRONG_SUBOBJ = 6
. " OIRE_VIRTUAL_LOCK_HANDLING




ABAP code using 7.40 inline data declarations to call FM OIRE_VIRTUAL_LOCK_HANDLING

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_i_lock_handler) = 'S'.
 
 
"SELECT single PROCDEF FROM OIRE_DTF_LOCK INTO @DATA(ld_i_procdef).
DATA(ld_i_procdef) = 'CC01'.
 
 
"SELECT single LOCKOBJ FROM OIRE_DTF_LOCK INTO @DATA(ld_i_lockobj).
 
 
"SELECT single ENQMODE FROM DD26E INTO @DATA(ld_i_lockmode).
DATA(ld_i_lockmode) = 'E'.
 
 
"SELECT single OBJECT_TYPE FROM OIRAPROCDEF INTO @DATA(ld_i_subobject).
DATA(ld_i_subobject) = 'CHOB'.
 
 
 


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!