SAP TXW_EXTRACT_READ_INIT Function Module for Initialize extract for reading









TXW_EXTRACT_READ_INIT is a standard txw extract read init SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Initialize extract for reading 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 txw extract read init FM, simply by entering the name TXW_EXTRACT_READ_INIT into the relevant SAP transaction such as SE37 or SE38.

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



Function TXW_EXTRACT_READ_INIT 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 'TXW_EXTRACT_READ_INIT'"Initialize extract for reading
EXPORTING
FILE_NAME = "File name
VOLDIR_SET = "Volume directory set
* CODEPAGE = "Codepage

IMPORTING
DESCRIPTION = "Tax file description

TABLES
* T_TXW_DIR2 = "Extract directory entries
* T_TXW_NOTE = "Note with plain text

EXCEPTIONS
FILE_OPEN_FAILED = 1 FILE_INVALID = 2 FILE_LOCKED = 3 LOCK_SYSTEM_FAILURE = 4 VOLDIR_SET_INVALID = 5 FILE_DIRECTORY_INVALID = 6 GET_FILENAME_FAILED = 7 NO_AUTHORITY = 8
.




Customer Function user exits

Below is a list of CUSTOMER FUNCTION exit user exits that are available within this program and maybe relevant for this FM.
EXIT_SAPLTXW2_001 Fill customer fields in SAP structures
EXIT_SAPLTXW2_002 Add customer defined data sources to data file

IMPORTING Parameters details for TXW_EXTRACT_READ_INIT

FILE_NAME - File name

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

VOLDIR_SET - Volume directory set

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

CODEPAGE - Codepage

Data type: TXW_CODEPAGE
Optional: Yes
Call by Reference: Yes

EXPORTING Parameters details for TXW_EXTRACT_READ_INIT

DESCRIPTION - Tax file description

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

TABLES Parameters details for TXW_EXTRACT_READ_INIT

T_TXW_DIR2 - Extract directory entries

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

T_TXW_NOTE - Note with plain text

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

EXCEPTIONS details

FILE_OPEN_FAILED - File could not be opened

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

FILE_INVALID - File directory is invalid

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

FILE_LOCKED - File is locked

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

LOCK_SYSTEM_FAILURE - Lock failed for system reasons

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

VOLDIR_SET_INVALID - Directory set is invalid (not defined)

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

FILE_DIRECTORY_INVALID - Invalid file directory (file not found)

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

GET_FILENAME_FAILED - Could not determine physical filename

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

NO_AUTHORITY - No authority to display tax file

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

Copy and paste ABAP code example for TXW_EXTRACT_READ_INIT 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_file_name  TYPE DART1_LFILE, "   
lt_t_txw_dir2  TYPE STANDARD TABLE OF TXW_DIR2, "   
lv_description  TYPE TXW_DIR2-TXTLG, "   
lv_file_open_failed  TYPE TXW_DIR2, "   
lt_t_txw_note  TYPE STANDARD TABLE OF TXW_NOTE, "   
lv_voldir_set  TYPE TXW_C_VOL-VOL_SET, "   
lv_file_invalid  TYPE TXW_C_VOL, "   
lv_codepage  TYPE TXW_CODEPAGE, "   
lv_file_locked  TYPE TXW_CODEPAGE, "   
lv_lock_system_failure  TYPE TXW_CODEPAGE, "   
lv_voldir_set_invalid  TYPE TXW_CODEPAGE, "   
lv_file_directory_invalid  TYPE TXW_CODEPAGE, "   
lv_get_filename_failed  TYPE TXW_CODEPAGE, "   
lv_no_authority  TYPE TXW_CODEPAGE. "   

  CALL FUNCTION 'TXW_EXTRACT_READ_INIT'  "Initialize extract for reading
    EXPORTING
         FILE_NAME = lv_file_name
         VOLDIR_SET = lv_voldir_set
         CODEPAGE = lv_codepage
    IMPORTING
         DESCRIPTION = lv_description
    TABLES
         T_TXW_DIR2 = lt_t_txw_dir2
         T_TXW_NOTE = lt_t_txw_note
    EXCEPTIONS
        FILE_OPEN_FAILED = 1
        FILE_INVALID = 2
        FILE_LOCKED = 3
        LOCK_SYSTEM_FAILURE = 4
        VOLDIR_SET_INVALID = 5
        FILE_DIRECTORY_INVALID = 6
        GET_FILENAME_FAILED = 7
        NO_AUTHORITY = 8
. " TXW_EXTRACT_READ_INIT




ABAP code using 7.40 inline data declarations to call FM TXW_EXTRACT_READ_INIT

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 TXTLG FROM TXW_DIR2 INTO @DATA(ld_description).
 
 
 
"SELECT single VOL_SET FROM TXW_C_VOL INTO @DATA(ld_voldir_set).
 
 
 
 
 
 
 
 
 


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!