SAP ARCHIVE_GET_TABLE Function Module for Read Records by Structure from the Current Data Object

Search SAP Function Modules

ARCHIVE_GET_TABLE is a standard archive get table SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read Records by Structure from the Current Data Object 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 archive get table FM, simply by entering the name ARCHIVE_GET_TABLE into the relevant SAP transaction such as SE37 or SE38.

Function Group: ARCH
Program Name: SAPLARCH
Main Program: SAPLARCH
Appliation area: S
Release date: 01-Jun-1995
Mode(Normal, Remote etc): Normal Function Module
Update:

Function ARCHIVE_GET_TABLE 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 'ARCHIVE_GET_TABLE'"Read Records by Structure from the Current Data Object
  EXPORTING
   ARCHIVE_HANDLE =  "Handle to the Open Archive Files
   RECORD_STRUCTURE =  "Name of Structure of All Data Records in the Table
*  ALL_RECORDS_OF_OBJECT = ' ' "Read All Records of the Structure in the Data Object
*  AUTOMATIC_CONVERSION = 'X' "Automatic Conversion of all Data Records
*  ARCHIVING_CLASS = ' ' "Archiving Class

 IMPORTING
   RECORD_CURSOR =  "Pointer to a Data Record in the Data Object
   RECORD_FLAGS =  "Flag Bar for All Data Records in the Table
   RECORD_LENGTH =  "Length of the Data Record in the Table

TABLES
   TABLE =  "Table Containing the Data Records
*  RECORD_FLAGS_TABLE =  "Flag Bar for All Data Records in the Table

EXCEPTIONS
   END_OF_OBJECT = 1    INTERNAL_ERROR = 2    WRONG_ACCESS_TO_ARCHIVE = 3 

.

IMPORTING Parameters details for ARCHIVE_GET_TABLE

ARCHIVE_HANDLE - Handle to the Open Archive Files

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

RECORD_STRUCTURE - Name of Structure of All Data Records in the Table

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

ALL_RECORDS_OF_OBJECT - Read All Records of the Structure in the Data Object

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

AUTOMATIC_CONVERSION - Automatic Conversion of all Data Records

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

ARCHIVING_CLASS - Archiving Class

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

EXPORTING Parameters details for ARCHIVE_GET_TABLE

RECORD_CURSOR - Pointer to a Data Record in the Data Object

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

RECORD_FLAGS - Flag Bar for All Data Records in the Table

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

RECORD_LENGTH - Length of the Data Record in the Table

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

TABLES Parameters details for ARCHIVE_GET_TABLE

TABLE - Table Containing the Data Records

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

RECORD_FLAGS_TABLE - Flag Bar for All Data Records in the Table

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

EXCEPTIONS details

END_OF_OBJECT - No Further Data Record Exists

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

INTERNAL_ERROR - Internal error

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

WRONG_ACCESS_TO_ARCHIVE - Incorrect Access to the Archive

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

Copy and paste ABAP code example for ARCHIVE_GET_TABLE 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.

ABAP code using 7.40 inline data declarations to call FM ARCHIVE_GET_TABLE

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.

Search for further information about these or an SAP related objects