SAP CLSX_SEARCH_OBJECTS Function Module for









CLSX_SEARCH_OBJECTS is a standard clsx search objects SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 clsx search objects FM, simply by entering the name CLSX_SEARCH_OBJECTS into the relevant SAP transaction such as SE37 or SE38.

Function Group: CLSX
Program Name: SAPLCLSX
Main Program: SAPLCLSX
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function CLSX_SEARCH_OBJECTS 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 'CLSX_SEARCH_OBJECTS'"
  EXPORTING
   I_CLASS =  "Class
*  I_ALL_VALUES = ' ' "
*  I_EXTERNAL_VIEW = 'X' "
*  I_NO_AUTH_CHECK = ' ' "No authorization check
   I_CLASSTYPE =  "Class Type
*  I_SUBCLASSES = ' ' "
*  I_OBJECTTYPE =  "
*  I_OBJECTNAME =  "
*  I_LANGUAGE = SY-LANGU "Language
*  I_KEYDATE = SY-DATUM "Key date for the selection
*  I_MAFID = ' ' "Indicator: Object/Class
*  I_MAXIMUM_NUMBER_OF_HITS = '999' "Maximum number of hits

TABLES
*  IT_SELECTION_TABLE =  "Selection Table for Value Transfer in Strings
*  ET_OBJECTS =  "Objects found
*  ET_VALUES =  "Table Type for AUSP
*  ET_OBJECTS_EXTERNAL_VIEW =  "Objects - External Format
*  ET_VALUES_EXTERNAL_VIEW =  "Assigned Values - External Format

EXCEPTIONS
   EX_NO_OBJECTS_FOUND = 1    EX_INCONSISTENT_PARAMETERS = 2    EX_CLASS_DOES_NOT_EXIST = 3    EX_NO_VALID_CHARACTERISTIC = 4    EX_NO_AUTHORITY_CLASSTYPE = 5    EX_NO_VALID_CLASSES = 6    EX_NO_VALID_SEARCH_PARAMETERS = 7
.



IMPORTING Parameters details for CLSX_SEARCH_OBJECTS

I_CLASS - Class

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

I_ALL_VALUES -

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

I_EXTERNAL_VIEW -

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

I_NO_AUTH_CHECK - No authorization check

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

I_CLASSTYPE - Class Type

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

I_SUBCLASSES -

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

I_OBJECTTYPE -

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

I_OBJECTNAME -

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

I_LANGUAGE - Language

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

I_KEYDATE - Key date for the selection

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

I_MAFID - Indicator: Object/Class

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

I_MAXIMUM_NUMBER_OF_HITS - Maximum number of hits

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

TABLES Parameters details for CLSX_SEARCH_OBJECTS

IT_SELECTION_TABLE - Selection Table for Value Transfer in Strings

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

ET_OBJECTS - Objects found

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

ET_VALUES - Table Type for AUSP

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

ET_OBJECTS_EXTERNAL_VIEW - Objects - External Format

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

ET_VALUES_EXTERNAL_VIEW - Assigned Values - External Format

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

EXCEPTIONS details

EX_NO_OBJECTS_FOUND - No objects found

Data type:
Optional: No
Call by Reference: Yes

EX_INCONSISTENT_PARAMETERS -

Data type:
Optional: No
Call by Reference: Yes

EX_CLASS_DOES_NOT_EXIST -

Data type:
Optional: No
Call by Reference: Yes

EX_NO_VALID_CHARACTERISTIC -

Data type:
Optional: No
Call by Reference: Yes

EX_NO_AUTHORITY_CLASSTYPE - No Authorization for Class Type

Data type:
Optional: No
Call by Reference: Yes

EX_NO_VALID_CLASSES -

Data type:
Optional: No
Call by Reference: Yes

EX_NO_VALID_SEARCH_PARAMETERS -

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for CLSX_SEARCH_OBJECTS 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_class  TYPE CLSX_STRING_250, "   
lt_it_selection_table  TYPE STANDARD TABLE OF CLSX_TT_SIMPLE_SELECTION, "   
lv_ex_no_objects_found  TYPE CLSX_TT_SIMPLE_SELECTION, "   
lv_i_all_values  TYPE CHAR01, "   SPACE
lv_i_external_view  TYPE CHAR01, "   'X'
lv_i_no_auth_check  TYPE CLSELBOOL, "   SPACE
lt_et_objects  TYPE STANDARD TABLE OF CLSX_TT_CLSEL_OBJECTS, "   
lv_i_classtype  TYPE CLSX_STRING_250, "   
lv_ex_inconsistent_parameters  TYPE CLSX_STRING_250, "   
lt_et_values  TYPE STANDARD TABLE OF TT_AUSP, "   
lv_i_subclasses  TYPE CHAR01, "   SPACE
lv_ex_class_does_not_exist  TYPE CHAR01, "   
lv_i_objecttype  TYPE TCLA-OBTAB, "   
lt_et_objects_external_view  TYPE STANDARD TABLE OF CLSX_TT_OBJECTS_EXTERNAL_VIEW, "   
lv_ex_no_valid_characteristic  TYPE CLSX_TT_OBJECTS_EXTERNAL_VIEW, "   
lv_i_objectname  TYPE KSSK-OBJEK, "   
lt_et_values_external_view  TYPE STANDARD TABLE OF CLSX_TT_VALUES_EXTERNAL_VIEW, "   
lv_ex_no_authority_classtype  TYPE CLSX_TT_VALUES_EXTERNAL_VIEW, "   
lv_i_language  TYPE SYST-LANGU, "   SY-LANGU
lv_ex_no_valid_classes  TYPE SYST, "   
lv_i_keydate  TYPE SYST-DATUM, "   SY-DATUM
lv_ex_no_valid_search_parameters  TYPE SYST, "   
lv_i_mafid  TYPE KSSK-MAFID, "   SPACE
lv_i_maximum_number_of_hits  TYPE MAX_HITS. "   '999'

  CALL FUNCTION 'CLSX_SEARCH_OBJECTS'  "
    EXPORTING
         I_CLASS = lv_i_class
         I_ALL_VALUES = lv_i_all_values
         I_EXTERNAL_VIEW = lv_i_external_view
         I_NO_AUTH_CHECK = lv_i_no_auth_check
         I_CLASSTYPE = lv_i_classtype
         I_SUBCLASSES = lv_i_subclasses
         I_OBJECTTYPE = lv_i_objecttype
         I_OBJECTNAME = lv_i_objectname
         I_LANGUAGE = lv_i_language
         I_KEYDATE = lv_i_keydate
         I_MAFID = lv_i_mafid
         I_MAXIMUM_NUMBER_OF_HITS = lv_i_maximum_number_of_hits
    TABLES
         IT_SELECTION_TABLE = lt_it_selection_table
         ET_OBJECTS = lt_et_objects
         ET_VALUES = lt_et_values
         ET_OBJECTS_EXTERNAL_VIEW = lt_et_objects_external_view
         ET_VALUES_EXTERNAL_VIEW = lt_et_values_external_view
    EXCEPTIONS
        EX_NO_OBJECTS_FOUND = 1
        EX_INCONSISTENT_PARAMETERS = 2
        EX_CLASS_DOES_NOT_EXIST = 3
        EX_NO_VALID_CHARACTERISTIC = 4
        EX_NO_AUTHORITY_CLASSTYPE = 5
        EX_NO_VALID_CLASSES = 6
        EX_NO_VALID_SEARCH_PARAMETERS = 7
. " CLSX_SEARCH_OBJECTS




ABAP code using 7.40 inline data declarations to call FM CLSX_SEARCH_OBJECTS

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_all_values) = ' '.
 
DATA(ld_i_external_view) = 'X'.
 
DATA(ld_i_no_auth_check) = ' '.
 
 
 
 
 
DATA(ld_i_subclasses) = ' '.
 
 
"SELECT single OBTAB FROM TCLA INTO @DATA(ld_i_objecttype).
 
 
 
"SELECT single OBJEK FROM KSSK INTO @DATA(ld_i_objectname).
 
 
 
"SELECT single LANGU FROM SYST INTO @DATA(ld_i_language).
DATA(ld_i_language) = SY-LANGU.
 
 
"SELECT single DATUM FROM SYST INTO @DATA(ld_i_keydate).
DATA(ld_i_keydate) = SY-DATUM.
 
 
"SELECT single MAFID FROM KSSK INTO @DATA(ld_i_mafid).
DATA(ld_i_mafid) = ' '.
 
DATA(ld_i_maximum_number_of_hits) = '999'.
 


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!