SAP SF_ST_TEXT_RETRIEVAL Function Module for Standard text retrieval for catalog (SO10)









SF_ST_TEXT_RETRIEVAL is a standard sf st text retrieval SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Standard text retrieval for catalog (SO10) 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 sf st text retrieval FM, simply by entering the name SF_ST_TEXT_RETRIEVAL into the relevant SAP transaction such as SE37 or SE38.

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



Function SF_ST_TEXT_RETRIEVAL 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 'SF_ST_TEXT_RETRIEVAL'"Standard text retrieval for catalog (SO10)
  EXPORTING
*  LANGUAGE = SY-LANGU "Language indicator
*  REFINING_STEP = ' ' "Indicator for refinement (='X')
*  TEXT_ID = 'ST' "SAPscript text ID

 IMPORTING
   NUMBER_OF_HITS =  "Number of found documents
   NUMBER_OF_LOST_HITS =  "Number of pointers that cannot be

TABLES
   KEY_TABLE =  "Document key (refinement and expor

EXCEPTIONS
   CANCELLED = 1    INTERN_ERROR = 2    KEY_INVALID = 3    REFINING_IMPOSSIBLE = 4
.



IMPORTING Parameters details for SF_ST_TEXT_RETRIEVAL

LANGUAGE - Language indicator

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

REFINING_STEP - Indicator for refinement (='X')

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

TEXT_ID - SAPscript text ID

Data type: THEAD-TDID
Default: 'ST'
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for SF_ST_TEXT_RETRIEVAL

NUMBER_OF_HITS - Number of found documents

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

NUMBER_OF_LOST_HITS - Number of pointers that cannot be

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

TABLES Parameters details for SF_ST_TEXT_RETRIEVAL

KEY_TABLE - Document key (refinement and expor

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

EXCEPTIONS details

CANCELLED - Abnormal termination of screen ent

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

INTERN_ERROR - Internal error.

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

KEY_INVALID - Invalid document key.

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

REFINING_IMPOSSIBLE - Refinement is not possible.

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

Copy and paste ABAP code example for SF_ST_TEXT_RETRIEVAL 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_language  TYPE SY-LANGU, "   SY-LANGU
lv_cancelled  TYPE SY, "   
lt_key_table  TYPE STANDARD TABLE OF PSCR, "   
lv_number_of_hits  TYPE FIST-HITS, "   
lv_intern_error  TYPE FIST, "   
lv_refining_step  TYPE RSFIN-BOOL, "   SPACE
lv_number_of_lost_hits  TYPE FIST-HITS, "   
lv_text_id  TYPE THEAD-TDID, "   'ST'
lv_key_invalid  TYPE THEAD, "   
lv_refining_impossible  TYPE THEAD. "   

  CALL FUNCTION 'SF_ST_TEXT_RETRIEVAL'  "Standard text retrieval for catalog (SO10)
    EXPORTING
         LANGUAGE = lv_language
         REFINING_STEP = lv_refining_step
         TEXT_ID = lv_text_id
    IMPORTING
         NUMBER_OF_HITS = lv_number_of_hits
         NUMBER_OF_LOST_HITS = lv_number_of_lost_hits
    TABLES
         KEY_TABLE = lt_key_table
    EXCEPTIONS
        CANCELLED = 1
        INTERN_ERROR = 2
        KEY_INVALID = 3
        REFINING_IMPOSSIBLE = 4
. " SF_ST_TEXT_RETRIEVAL




ABAP code using 7.40 inline data declarations to call FM SF_ST_TEXT_RETRIEVAL

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 LANGU FROM SY INTO @DATA(ld_language).
DATA(ld_language) = SY-LANGU.
 
 
 
"SELECT single HITS FROM FIST INTO @DATA(ld_number_of_hits).
 
 
"SELECT single BOOL FROM RSFIN INTO @DATA(ld_refining_step).
DATA(ld_refining_step) = ' '.
 
"SELECT single HITS FROM FIST INTO @DATA(ld_number_of_lost_hits).
 
"SELECT single TDID FROM THEAD INTO @DATA(ld_text_id).
DATA(ld_text_id) = 'ST'.
 
 
 


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!