SAP C14SX_DOCUMENT_LOCK_SET Function Module for NOTRANSL: EHS: Setzten der Sperre auf ein Dokument

Search SAP Function Modules

C14SX_DOCUMENT_LOCK_SET is a standard c14sx document lock set SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for NOTRANSL: EHS: Setzten der Sperre auf ein Dokument 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 c14sx document lock set FM, simply by entering the name C14SX_DOCUMENT_LOCK_SET into the relevant SAP transaction such as SE37 or SE38.

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

Function C14SX_DOCUMENT_LOCK_SET 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 'C14SX_DOCUMENT_LOCK_SET'"NOTRANSL: EHS: Setzten der Sperre auf ein Dokument
  EXPORTING
   I_LOCKMODE =  "Activity Type
   I_DOCKEY =  "Report Key
*  I_SCOPE = 1 "Control Lock Behavior When Calling the Update Task
*  I_WAIT = ESP1_FALSE "Flag Indicating Whether Lock Attempt Is to Be Repeated
*  I_WAIT_LOOP = 0 "Number

 IMPORTING
   E_LOCKMODE =  "Activity Type

TABLES
*  E_EXTERROR_TAB =  "

EXCEPTIONS
   NO_LOCK = 1 

.

IMPORTING Parameters details for C14SX_DOCUMENT_LOCK_SET

I_LOCKMODE - Activity Type

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

I_DOCKEY - Report Key

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

I_SCOPE - Control Lock Behavior When Calling the Update Task

Data type: DDENQSCOPE
Default: 1
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_WAIT - Flag Indicating Whether Lock Attempt Is to Be Repeated

Data type: DDENQWAIT
Default: ESP1_FALSE
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_WAIT_LOOP - Number

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

EXPORTING Parameters details for C14SX_DOCUMENT_LOCK_SET

E_LOCKMODE - Activity Type

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

TABLES Parameters details for C14SX_DOCUMENT_LOCK_SET

E_EXTERROR_TAB -

Data type: ESPAP_EXTERROR_TAB_TYPE
Optional: Yes
Call by Reference: Yes

EXCEPTIONS details

NO_LOCK - Unable to set lock

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

Copy and paste ABAP code example for C14SX_DOCUMENT_LOCK_SET 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.

ABAP code using 7.40 inline data declarations to call FM C14SX_DOCUMENT_LOCK_SET

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.

Search for further information about these or an SAP related objects