TREX_EXT_GET_FILE SAP Function module - Get list of trace files for one TREX landscape

TREX_EXT_GET_FILE 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 TREX_EXT_GET_FILE into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: TREX_EXT_TRACE
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM TREX_EXT_GET_FILE - TREX EXT GET FILE

CALL FUNCTION 'TREX_EXT_GET_FILE' "Get list of trace files for one TREX landscape
  EXPORTING
    i_rfc_destination =         " trex_rfc-rfc_destination  RFC destination to TREX engine
    i_file_path =               " trexs_file-file_path  File name pattern or fileName (if directory_type>0)
*   i_host =                    " trexs_file-host  Host
*   i_head_offset = 0           " numc10        Offset for i_head_length
*   i_head_length = 0           " numc10        Length in bytes from the beginning
*   i_bin_mode =                " trex_rfc-flag  Indicator
*   i_size_only =               " trex_rfc-flag  Indicator
  IMPORTING
    e_return_code =             " trex_rfc-return_code  Return code
    e_return_text =             " trex_rfc-return_text  Return text
    e_lines =                   " trext_lines   Content of the file
    e_lines_bin =               " trexx_lines   COntent of the file in BIN (RAW) format
    e_file_size =               " trexs_file-size  File size
    e_ascii =                   " trexs_file-ascii  Identifier is content is ASCII (='X') or binary
  EXCEPTIONS
    CONVERSION_ERROR = 1        "               Error during conversion to UTF-8
    ERROR = 2                   "               Error, see error message
    NO_AUTHORIZATION = 3        "
    .  "  TREX_EXT_GET_FILE

ABAP code example for Function Module TREX_EXT_GET_FILE

The ABAP code below is a full code listing to execute function module TREX_EXT_GET_FILE 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_return_code  
 
 TYPE TREX_RFC-RETURN_CODE
,
ld_e_return_text  
 
 TYPE TREX_RFC-RETURN_TEXT
,
ld_e_lines  
 
 TYPE TREXT_LINES
,
ld_e_lines_bin  
 
 TYPE TREXX_LINES
,
ld_e_file_size  
 
 TYPE TREXS_FILE-SIZE
,
ld_e_ascii  
 
 TYPE TREXS_FILE-ASCII
.



DATA(ld_i_rfc_destination) = some text here


DATA(ld_i_file_path) = some text here


DATA(ld_i_host) = some text here

DATA(ld_i_head_offset) = 'Check type of data required'.

DATA(ld_i_head_length) = 'Check type of data required'.


DATA(ld_i_bin_mode) = some text here


DATA(ld_i_size_only) = some text here
.

CALL FUNCTION 'TREX_EXT_GET_FILE'
  EXPORTING
    i_rfc_destination =          ld_i_rfc_destination
    i_file_path =                ld_i_file_path
*   i_host =                     ld_i_host
*   i_head_offset =              ld_i_head_offset
*   i_head_length =              ld_i_head_length
*   i_bin_mode =                 ld_i_bin_mode
*   i_size_only =                ld_i_size_only
  IMPORTING
    e_return_code =              ld_e_return_code
    e_return_text =              ld_e_return_text
    e_lines =                    ld_e_lines
    e_lines_bin =                ld_e_lines_bin
    e_file_size =                ld_e_file_size
    e_ascii =                    ld_e_ascii
  EXCEPTIONS
    CONVERSION_ERROR =           1
    ERROR =                      2
    NO_AUTHORIZATION =           3
    .  "  TREX_EXT_GET_FILE

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
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_return_code
 
 TYPE TREX_RFC-RETURN_CODE ,
ld_i_rfc_destination
 
 TYPE TREX_RFC-RFC_DESTINATION ,
ld_e_return_text
 
 TYPE TREX_RFC-RETURN_TEXT ,
ld_i_file_path
 
 TYPE TREXS_FILE-FILE_PATH ,
ld_e_lines
 
 TYPE TREXT_LINES ,
ld_i_host
 
 TYPE TREXS_FILE-HOST ,
ld_e_lines_bin
 
 TYPE TREXX_LINES ,
ld_i_head_offset
 
 TYPE NUMC10 ,
ld_e_file_size
 
 TYPE TREXS_FILE-SIZE ,
ld_i_head_length
 
 TYPE NUMC10 ,
ld_e_ascii
 
 TYPE TREXS_FILE-ASCII ,
ld_i_bin_mode
 
 TYPE TREX_RFC-FLAG ,
ld_i_size_only
 
 TYPE TREX_RFC-FLAG .



ld_i_rfc_destination = some text here

ld_i_file_path = some text here

ld_i_host = some text here
ld_i_head_offset = 'Check type of data required'.
ld_i_head_length = 'Check type of data required'.

ld_i_bin_mode = some text here

ld_i_size_only = some text here