SAP BX_SEARCH_OBJECT Function Module for









BX_SEARCH_OBJECT is a standard bx search object 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 bx search object FM, simply by entering the name BX_SEARCH_OBJECT into the relevant SAP transaction such as SE37 or SE38.

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



Function BX_SEARCH_OBJECT 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 'BX_SEARCH_OBJECT'"
EXPORTING
SEARCH_TEXT = "Search Text
* SHOW_AGR_NAME_IF_POSSIBLE = ' ' "
* USER_NAME = SY-UNAME "
* LANGUAGE = SY-LANGU "

TABLES
RESULT_TAB = "

EXCEPTIONS
TEXT_OR_TCODE_NOT_FOUND = 1
.



IMPORTING Parameters details for BX_SEARCH_OBJECT

SEARCH_TEXT - Search Text

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

SHOW_AGR_NAME_IF_POSSIBLE -

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

USER_NAME -

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

LANGUAGE -

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

TABLES Parameters details for BX_SEARCH_OBJECT

RESULT_TAB -

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

EXCEPTIONS details

TEXT_OR_TCODE_NOT_FOUND - Text Not Found

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

Copy and paste ABAP code example for BX_SEARCH_OBJECT 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_result_tab  TYPE STANDARD TABLE OF BXMNODES1, "   
lv_search_text  TYPE AGR_HIERT-TEXT, "   
lv_text_or_tcode_not_found  TYPE AGR_HIERT, "   
lv_show_agr_name_if_possible  TYPE SMENSAPNEW-CUSTOMIZED, "   SPACE
lv_user_name  TYPE SY-UNAME, "   SY-UNAME
lv_language  TYPE SY-LANGU. "   SY-LANGU

  CALL FUNCTION 'BX_SEARCH_OBJECT'  "
    EXPORTING
         SEARCH_TEXT = lv_search_text
         SHOW_AGR_NAME_IF_POSSIBLE = lv_show_agr_name_if_possible
         USER_NAME = lv_user_name
         LANGUAGE = lv_language
    TABLES
         RESULT_TAB = lt_result_tab
    EXCEPTIONS
        TEXT_OR_TCODE_NOT_FOUND = 1
. " BX_SEARCH_OBJECT




ABAP code using 7.40 inline data declarations to call FM BX_SEARCH_OBJECT

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.

 
"SELECT single TEXT FROM AGR_HIERT INTO @DATA(ld_search_text).
 
 
"SELECT single CUSTOMIZED FROM SMENSAPNEW INTO @DATA(ld_show_agr_name_if_possible).
DATA(ld_show_agr_name_if_possible) = ' '.
 
"SELECT single UNAME FROM SY INTO @DATA(ld_user_name).
DATA(ld_user_name) = SY-UNAME.
 
"SELECT single LANGU FROM SY INTO @DATA(ld_language).
DATA(ld_language) = SY-LANGU.
 


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!