ENQUEUE_E_GRFNTASKPLAN SAP Function module - Request lock for object E_GRFNTASKPLAN

ENQUEUE_E_GRFNTASKPLAN is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name ENQUEUE_E_GRFNTASKPLAN into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: DWBEN/SAPLGEN0002
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM ENQUEUE_E_GRFNTASKPLAN - ENQUEUE E GRFNTASKPLAN

CALL FUNCTION 'ENQUEUE_E_GRFNTASKPLAN' "Request lock for object E_GRFNTASKPLAN
* EXPORTING
*   mode_grfntaskplan = 'E'     " enqmode       Lock mode for table GRFNTASKPLAN
*   mandt = SY-MANDT            " grfntaskplan-mandt  01th enqueue argument
*   taskplan_id =               " grfntaskplan-taskplan_id  02th enqueue argument
*   x_taskplan_id = SPACE       "               Fill argument 02 with initial value?
*   _scope = '2'                "
*   _wait = SPACE               "
*   _collect = ' '              " ddenqcoll     Initially only collect lock
  EXCEPTIONS
    FOREIGN_LOCK = 1            "               Object already locked
    SYSTEM_FAILURE = 2          "               Internal error from enqueue server
    .  "  ENQUEUE_E_GRFNTASKPLAN

ABAP code example for Function Module ENQUEUE_E_GRFNTASKPLAN

The ABAP code below is a full code listing to execute function module ENQUEUE_E_GRFNTASKPLAN including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

DATA(ld_mode_grfntaskplan) = 'Check type of data required'.
 

SELECT single MANDT 
  FROM GRFNTASKPLAN 
  INTO @DATA(ld_mandt).

 

SELECT single TASKPLAN_ID 
  FROM GRFNTASKPLAN 
  INTO @DATA(ld_taskplan_id).


DATA(ld_x_taskplan_id) = 'some text here'.

DATA(ld__scope) = 'some text here'.

DATA(ld__wait) = 'some text here'.

DATA(ld__collect) = 'Check type of data required'.
.

CALL FUNCTION 'ENQUEUE_E_GRFNTASKPLAN'
* EXPORTING
*   mode_grfntaskplan =          ld_mode_grfntaskplan
*   mandt =                      ld_mandt
*   taskplan_id =                ld_taskplan_id
*   x_taskplan_id =              ld_x_taskplan_id
*   _scope =                     ld__scope
*   _wait =                      ld__wait
*   _collect =                   ld__collect
  EXCEPTIONS
    FOREIGN_LOCK =               1
    SYSTEM_FAILURE =             2
    .  "  ENQUEUE_E_GRFNTASKPLAN

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_mode_grfntaskplan
 
 TYPE ENQMODE ,
ld_mandt
 
 TYPE GRFNTASKPLAN-MANDT ,
ld_taskplan_id
 
 TYPE GRFNTASKPLAN-TASKPLAN_ID ,
ld_x_taskplan_id
 
 TYPE STRING ,
ld__scope
 
 TYPE STRING ,
ld__wait
 
 TYPE STRING ,
ld__collect
 
 TYPE DDENQCOLL .


ld_mode_grfntaskplan = 'Check type of data required'.

SELECT single MANDT 
  FROM GRFNTASKPLAN 
  INTO ld_mandt.


SELECT single TASKPLAN_ID 
  FROM GRFNTASKPLAN 
  INTO ld_taskplan_id.

ld_x_taskplan_id = 'some text here'.
ld__scope = 'some text here'.
ld__wait = 'some text here'.
ld__collect = 'Check type of data required'.