SAP ARCHIVE_GET_NEXT_RECORD Function Module for Sequential Read of the Records from a Data Object









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

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



Function ARCHIVE_GET_NEXT_RECORD 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_NEXT_RECORD'"Sequential Read of the Records from a Data Object
EXPORTING
ARCHIVE_HANDLE = "Handle to the Open Archive Files
* GET_REAL_STRUCTURE_NAME = 'X' "Conversion of the Structure Name
* AUTOMATIC_CONVERSION = 'X' "Automatic Conversion of the Data Record

IMPORTING
RECORD = "Data Record
RECORD_CURSOR = "Pointer to Data Record
RECORD_FLAGS = "Flag Bar per Data Record
RECORD_STRUCTURE = "Name of Returned Structure
RECORD_LENGTH = "Length of the Data Record in Parameter RECORD
RECORD_REF = "Reference to Data Record

EXCEPTIONS
END_OF_OBJECT = 1 INTERNAL_ERROR = 2 WRONG_ACCESS_TO_ARCHIVE = 3
.



IMPORTING Parameters details for ARCHIVE_GET_NEXT_RECORD

ARCHIVE_HANDLE - Handle to the Open Archive Files

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

GET_REAL_STRUCTURE_NAME - Conversion of the Structure Name

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

AUTOMATIC_CONVERSION - Automatic Conversion of the Data Record

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

EXPORTING Parameters details for ARCHIVE_GET_NEXT_RECORD

RECORD - Data Record

Data type:
Optional: No
Call by Reference: Yes

RECORD_CURSOR - Pointer to Data Record

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

RECORD_FLAGS - Flag Bar per Data Record

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

RECORD_STRUCTURE - Name of Returned Structure

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

RECORD_LENGTH - Length of the Data Record in Parameter RECORD

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

RECORD_REF - Reference to Data Record

Data type: DATA
Optional: No
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_NEXT_RECORD 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_record  TYPE STRING, "   
lv_end_of_object  TYPE STRING, "   
lv_archive_handle  TYPE SY-TABIX, "   
lv_record_cursor  TYPE SY-TABIX, "   
lv_internal_error  TYPE SY, "   
lv_get_real_structure_name  TYPE SY, "   'X'
lv_record_flags  TYPE ARC_BUFFER-FLAGS, "   
lv_automatic_conversion  TYPE ARC_BUFFER, "   'X'
lv_wrong_access_to_archive  TYPE ARC_BUFFER, "   
lv_record_structure  TYPE ARC_BUFFER-RNAME, "   
lv_record_length  TYPE ARCH_INT-INT4, "   
lv_record_ref  TYPE DATA. "   

  CALL FUNCTION 'ARCHIVE_GET_NEXT_RECORD'  "Sequential Read of the Records from a Data Object
    EXPORTING
         ARCHIVE_HANDLE = lv_archive_handle
         GET_REAL_STRUCTURE_NAME = lv_get_real_structure_name
         AUTOMATIC_CONVERSION = lv_automatic_conversion
    IMPORTING
         RECORD = lv_record
         RECORD_CURSOR = lv_record_cursor
         RECORD_FLAGS = lv_record_flags
         RECORD_STRUCTURE = lv_record_structure
         RECORD_LENGTH = lv_record_length
         RECORD_REF = lv_record_ref
    EXCEPTIONS
        END_OF_OBJECT = 1
        INTERNAL_ERROR = 2
        WRONG_ACCESS_TO_ARCHIVE = 3
. " ARCHIVE_GET_NEXT_RECORD




ABAP code using 7.40 inline data declarations to call FM ARCHIVE_GET_NEXT_RECORD

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 TABIX FROM SY INTO @DATA(ld_archive_handle).
 
"SELECT single TABIX FROM SY INTO @DATA(ld_record_cursor).
 
 
DATA(ld_get_real_structure_name) = 'X'.
 
"SELECT single FLAGS FROM ARC_BUFFER INTO @DATA(ld_record_flags).
 
DATA(ld_automatic_conversion) = 'X'.
 
 
"SELECT single RNAME FROM ARC_BUFFER INTO @DATA(ld_record_structure).
 
"SELECT single INT4 FROM ARCH_INT INTO @DATA(ld_record_length).
 
 


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!