UPX_API_SEARCH_HELP SAP Function module - Show search help and return the value

UPX_API_SEARCH_HELP is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name UPX_API_SEARCH_HELP into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: UPX_API
Released Date: Not Released
Processing type: Remote-Enabled

Pattern for FM UPX_API_SEARCH_HELP - UPX API SEARCH HELP

CALL FUNCTION 'UPX_API_SEARCH_HELP' "Show search help and return the value
  EXPORTING
    i_chanm =                   " upx_api_ys_main-chanm  Characteristic
  IMPORTING
    e_chavl =                   " upc_ys_api_data-value  Characteristic Value, External API
    e_text =                    " upx_api_ys_main-text  Description of Hierarchy Derivation/Char. Arrangement
    e_canceled =                " upx_api_ys_main-canceled  Checkbox Field
* TABLES
*   et_return =                 " bapiret2      Return Parameter
    .  "  UPX_API_SEARCH_HELP

ABAP code example for Function Module UPX_API_SEARCH_HELP

The ABAP code below is a full code listing to execute function module UPX_API_SEARCH_HELP including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

DATA:
ld_e_chavl  
 
 TYPE UPC_YS_API_DATA-VALUE
,
ld_e_text  
 
 TYPE UPX_API_YS_MAIN-TEXT
,
ld_e_canceled  
 
 TYPE UPX_API_YS_MAIN-CANCELED
,
it_et_return  
 
 TYPE STANDARD TABLE OF BAPIRET2,"TABLES PARAM
wa_et_return
 
 LIKE LINE OF it_et_return
.



DATA(ld_i_chanm) = some text here
 

"populate fields of struture and append to itab
append wa_et_return to it_et_return.
.

CALL FUNCTION 'UPX_API_SEARCH_HELP'
  EXPORTING
    i_chanm =                    ld_i_chanm
  IMPORTING
    e_chavl =                    ld_e_chavl
    e_text =                     ld_e_text
    e_canceled =                 ld_e_canceled
* TABLES
*   et_return =                  it_et_return
    .  "  UPX_API_SEARCH_HELP

IF SY-SUBRC EQ 0.
  "All OK
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_e_chavl
 
 TYPE UPC_YS_API_DATA-VALUE ,
ld_i_chanm
 
 TYPE UPX_API_YS_MAIN-CHANM ,
it_et_return
 
 TYPE STANDARD TABLE OF BAPIRET2 ,
wa_et_return
 
 LIKE LINE OF it_et_return,
ld_e_text
 
 TYPE UPX_API_YS_MAIN-TEXT ,
ld_e_canceled
 
 TYPE UPX_API_YS_MAIN-CANCELED .



ld_i_chanm = some text here 

"populate fields of struture and append to itab
append wa_et_return to it_et_return.