SAP CLOCH_OBJECT_CHECK Function Module for Classification: Attributes of an Object









CLOCH_OBJECT_CHECK is a standard cloch object check SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Classification: Attributes of an 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 cloch object check FM, simply by entering the name CLOCH_OBJECT_CHECK into the relevant SAP transaction such as SE37 or SE38.

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



Function CLOCH_OBJECT_CHECK 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 'CLOCH_OBJECT_CHECK'"Classification: Attributes of an Object
  EXPORTING
   I_OBTAB =  "Name of Database Table for Object
*  CALLED_FROM = 1 "
*  LANGUAGE = SY-LANGU "SAP R/3 System, Current Language
*  LOCK = ' ' "
*  SINGLE = ' ' "
*  DATE_OF_CHANGE =  "Valid-From Date
*  I_AUTH_CHK = ' ' "Checkbox
*  I_CALLED_FROM_API = ' ' "

 IMPORTING
   FAULT_TEXT =  "Error Text for Output in Classification
   MEINS =  "Unit of Measure
   MESSAGE_TYPE =  "Message Type E,W,I, or S
   NO_AUTH =  "No Authorization for Object
   NO_CHANGES =  "No Object Changes
   DISTRIBUTION_LOCK =  "Distribution Lock is Set

TABLES
   OTAB =  "Table of Objects

EXCEPTIONS
   FOREIGN_LOCK = 1    OBJECT_NOT_FOUND = 2    SYSTEM_FAILURE = 3    FUNC_MISSING = 4
.



IMPORTING Parameters details for CLOCH_OBJECT_CHECK

I_OBTAB - Name of Database Table for Object

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

CALLED_FROM -

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

LANGUAGE - SAP R/3 System, Current Language

Data type: SYLANGU
Default: SY-LANGU
Optional: Yes
Call by Reference: No ( called with pass by value option)

LOCK -

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

SINGLE -

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

DATE_OF_CHANGE - Valid-From Date

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

I_AUTH_CHK - Checkbox

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

I_CALLED_FROM_API -

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

EXPORTING Parameters details for CLOCH_OBJECT_CHECK

FAULT_TEXT - Error Text for Output in Classification

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

MEINS - Unit of Measure

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

MESSAGE_TYPE - Message Type E,W,I, or S

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

NO_AUTH - No Authorization for Object

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

NO_CHANGES - No Object Changes

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

DISTRIBUTION_LOCK - Distribution Lock is Set

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

TABLES Parameters details for CLOCH_OBJECT_CHECK

OTAB - Table of Objects

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

EXCEPTIONS details

FOREIGN_LOCK - Record Locked by Another User

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

OBJECT_NOT_FOUND - Material Does Not Exist

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

SYSTEM_FAILURE - System Error When Locking

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

FUNC_MISSING -

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for CLOCH_OBJECT_CHECK 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:
lt_otab  TYPE STANDARD TABLE OF RMCLOBTX, "   
lv_i_obtab  TYPE TABELLE, "   
lv_fault_text  TYPE TABELLE, "   
lv_foreign_lock  TYPE TABELLE, "   
lv_meins  TYPE MEINS, "   
lv_called_from  TYPE MEINS, "   1
lv_object_not_found  TYPE MEINS, "   
lv_language  TYPE SYLANGU, "   SY-LANGU
lv_message_type  TYPE SYLANGU, "   
lv_system_failure  TYPE SYLANGU, "   
lv_lock  TYPE SYLANGU, "   SPACE
lv_no_auth  TYPE SYLANGU, "   
lv_func_missing  TYPE SYLANGU, "   
lv_single  TYPE SYLANGU, "   SPACE
lv_no_changes  TYPE CHAR1, "   
lv_date_of_change  TYPE DATUV, "   
lv_distribution_lock  TYPE DLOCK, "   
lv_i_auth_chk  TYPE XFELD, "   SPACE
lv_i_called_from_api  TYPE XFELD. "   SPACE

  CALL FUNCTION 'CLOCH_OBJECT_CHECK'  "Classification: Attributes of an Object
    EXPORTING
         I_OBTAB = lv_i_obtab
         CALLED_FROM = lv_called_from
         LANGUAGE = lv_language
         LOCK = lv_lock
         SINGLE = lv_single
         DATE_OF_CHANGE = lv_date_of_change
         I_AUTH_CHK = lv_i_auth_chk
         I_CALLED_FROM_API = lv_i_called_from_api
    IMPORTING
         FAULT_TEXT = lv_fault_text
         MEINS = lv_meins
         MESSAGE_TYPE = lv_message_type
         NO_AUTH = lv_no_auth
         NO_CHANGES = lv_no_changes
         DISTRIBUTION_LOCK = lv_distribution_lock
    TABLES
         OTAB = lt_otab
    EXCEPTIONS
        FOREIGN_LOCK = 1
        OBJECT_NOT_FOUND = 2
        SYSTEM_FAILURE = 3
        FUNC_MISSING = 4
. " CLOCH_OBJECT_CHECK




ABAP code using 7.40 inline data declarations to call FM CLOCH_OBJECT_CHECK

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_called_from) = 1.
 
 
DATA(ld_language) = SY-LANGU.
 
 
 
DATA(ld_lock) = ' '.
 
 
 
DATA(ld_single) = ' '.
 
 
 
 
DATA(ld_i_auth_chk) = ' '.
 
DATA(ld_i_called_from_api) = ' '.
 


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!