SAP ARCHIVE_OPEN_FOR_READ Function Module for Open an Existing Archive File for Reading

Search SAP Function Modules

ARCHIVE_OPEN_FOR_READ is a standard archive open for read SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Open an Existing Archive File 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 archive open for read FM, simply by entering the name ARCHIVE_OPEN_FOR_READ into the relevant SAP transaction such as SE37 or SE38.

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

Function ARCHIVE_OPEN_FOR_READ 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_OPEN_FOR_READ'"Open an Existing Archive File for Reading
  EXPORTING
*  ARCHIVE_DOCUMENT = '000000' "Archive Name According to Archive Management
*  ARCHIVE_NAME = ' ' "Archive File Name According to Archive Management
   OBJECT =  "Archiving Object Name
*  MAINTAIN_INDEX = ' ' "Indicator for Index Build

 IMPORTING
   ARCHIVE_HANDLE =  "Handle to the Open Files

TABLES
*  ARCHIVE_FILES =  "Table of the Required Archive Files
*  SELECTED_FILES =  "Table with the Selected Entries

EXCEPTIONS
   FILE_ALREADY_OPEN = 1    FILE_IO_ERROR = 2    INTERNAL_ERROR = 3    NO_FILES_AVAILABLE = 4    OBJECT_NOT_FOUND = 5    OPEN_ERROR = 6    NOT_AUTHORIZED = 7    ARCHIVING_STANDARD_VIOLATION = 8 

.

IMPORTING Parameters details for ARCHIVE_OPEN_FOR_READ

ARCHIVE_DOCUMENT - Archive Name According to Archive Management

Data type: ADMI_RUN-DOCUMENT
Default: '000000'
Optional: Yes
Call by Reference: No ( called with pass by value option)

ARCHIVE_NAME - Archive File Name According to Archive Management

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

OBJECT - Archiving Object Name

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

MAINTAIN_INDEX - Indicator for Index Build

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

EXPORTING Parameters details for ARCHIVE_OPEN_FOR_READ

ARCHIVE_HANDLE - Handle to the Open Files

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

TABLES Parameters details for ARCHIVE_OPEN_FOR_READ

ARCHIVE_FILES - Table of the Required Archive Files

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

SELECTED_FILES - Table with the Selected Entries

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

EXCEPTIONS details

FILE_ALREADY_OPEN - The System Tried Repeatedly to Open a File

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

FILE_IO_ERROR - Archive File Access Error

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)

NO_FILES_AVAILABLE - No Files Exist for Object

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

OBJECT_NOT_FOUND - Object Unknown

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

OPEN_ERROR - Could not open file

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

NOT_AUTHORIZED - No Authorization for ARCHIVE_OPEN_FOR_READ

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

ARCHIVING_STANDARD_VIOLATION - Violation of the Archiving Standard

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for ARCHIVE_OPEN_FOR_READ 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_OPEN_FOR_READ

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