SAP /PF1/FB_API_CA_LOCK_CB Function Module for Release Tool: Set or delete SAP locks for the object

Search SAP Function Modules

/PF1/FB_API_CA_LOCK_CB is a standard /pf1/fb api ca lock cb 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 Tool: Set or delete SAP locks for the object 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 /pf1/fb api ca lock cb FM, simply by entering the name /PF1/FB_API_CA_LOCK_CB into the relevant SAP transaction such as SE37 or SE38.

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

Function /PF1/FB_API_CA_LOCK_CB 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 '/PF1/FB_API_CA_LOCK_CB'"Release Tool: Set or delete SAP locks for the object
  EXPORTING
   I_REL_OBJECT_KEY =  "Object Key (Chain of Object Key Fields)
   I_FLG_LOCKSET =  "Boolean Variable

EXCEPTIONS
   OBJECT_LOCKED = 1    OBJECT_ERROR = 2 

.

IMPORTING Parameters details for /PF1/FB_API_CA_LOCK_CB

I_REL_OBJECT_KEY - Object Key (Chain of Object Key Fields)

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

I_FLG_LOCKSET - Boolean Variable

Data type: /PF1/BANK_BOOLEAN
Optional: No
Call by Reference: Yes

EXCEPTIONS details

OBJECT_LOCKED - Object locked

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

OBJECT_ERROR - General error

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

Copy and paste ABAP code example for /PF1/FB_API_CA_LOCK_CB 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 /PF1/FB_API_CA_LOCK_CB

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