SAP HLP_CAPTIONS_GET Function Module for Online Help: Create Localization Data









HLP_CAPTIONS_GET is a standard hlp captions get SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Online Help: Create Localization Data 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 hlp captions get FM, simply by entering the name HLP_CAPTIONS_GET into the relevant SAP transaction such as SE37 or SE38.

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



Function HLP_CAPTIONS_GET 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 'HLP_CAPTIONS_GET'"Online Help: Create Localization Data
EXPORTING
HELP_TYPE = "
DISPLAY_MODE = "
* MEMORY_TOP = 0 "
* TAB_CAPTION = ' ' "
* HELP_INFOS = ' ' "

TABLES
CAPTIONS = "
* EXCLUDED_FCODES = "
.



IMPORTING Parameters details for HLP_CAPTIONS_GET

HELP_TYPE -

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

DISPLAY_MODE -

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

MEMORY_TOP -

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

TAB_CAPTION -

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

HELP_INFOS -

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

TABLES Parameters details for HLP_CAPTIONS_GET

CAPTIONS -

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

EXCLUDED_FCODES -

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

Copy and paste ABAP code example for HLP_CAPTIONS_GET 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_captions  TYPE STANDARD TABLE OF HLPCAPTION, "   
lv_help_type  TYPE HLPFIELDS-HELP_TYPE, "   
lv_display_mode  TYPE HLPFIELDS-DISP_MODE, "   
lt_excluded_fcodes  TYPE STANDARD TABLE OF HLPFCODE, "   
lv_memory_top  TYPE I, "   0
lv_tab_caption  TYPE HLPCAPTION-TEXT, "   SPACE
lv_help_infos  TYPE HELP_INFO. "   SPACE

  CALL FUNCTION 'HLP_CAPTIONS_GET'  "Online Help: Create Localization Data
    EXPORTING
         HELP_TYPE = lv_help_type
         DISPLAY_MODE = lv_display_mode
         MEMORY_TOP = lv_memory_top
         TAB_CAPTION = lv_tab_caption
         HELP_INFOS = lv_help_infos
    TABLES
         CAPTIONS = lt_captions
         EXCLUDED_FCODES = lt_excluded_fcodes
. " HLP_CAPTIONS_GET




ABAP code using 7.40 inline data declarations to call FM HLP_CAPTIONS_GET

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 HELP_TYPE FROM HLPFIELDS INTO @DATA(ld_help_type).
 
"SELECT single DISP_MODE FROM HLPFIELDS INTO @DATA(ld_display_mode).
 
 
 
"SELECT single TEXT FROM HLPCAPTION INTO @DATA(ld_tab_caption).
DATA(ld_tab_caption) = ' '.
 
DATA(ld_help_infos) = ' '.
 


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!