SAP ARCHIVE_GET_OBJECT_BY_OFFSET Function Module for









ARCHIVE_GET_OBJECT_BY_OFFSET is a standard archive get object by offset SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used to perform a specific ABAP function and below is the pattern details, 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 object by offset FM, simply by entering the name ARCHIVE_GET_OBJECT_BY_OFFSET into the relevant SAP transaction such as SE37 or SE38.

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



Function ARCHIVE_GET_OBJECT_BY_OFFSET 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_OBJECT_BY_OFFSET'"
EXPORTING
* ARCHIVKEY = ' ' "
OFFSET = 0 "

IMPORTING
ARCHIVE_HANDLE = "

EXCEPTIONS
NO_RECORD_FOUND = 1 FILE_IO_ERROR = 2 INTERNAL_ERROR = 3 OPEN_ERROR = 4 OBJECT_NOT_FOUND = 5 NOT_AUTHORIZED = 6
.



IMPORTING Parameters details for ARCHIVE_GET_OBJECT_BY_OFFSET

ARCHIVKEY -

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

OFFSET -

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

EXPORTING Parameters details for ARCHIVE_GET_OBJECT_BY_OFFSET

ARCHIVE_HANDLE -

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

EXCEPTIONS details

NO_RECORD_FOUND -

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

FILE_IO_ERROR -

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

INTERNAL_ERROR -

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

OPEN_ERROR -

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

OBJECT_NOT_FOUND -

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

NOT_AUTHORIZED -

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

Copy and paste ABAP code example for ARCHIVE_GET_OBJECT_BY_OFFSET 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_archivkey  TYPE ARCH_IDX-ARCHIVEKEY, "   SPACE
lv_archive_handle  TYPE SY-TABIX, "   
lv_no_record_found  TYPE SY, "   
lv_offset  TYPE ARCH_IDX-OFFSET, "   0
lv_file_io_error  TYPE ARCH_IDX, "   
lv_internal_error  TYPE ARCH_IDX, "   
lv_open_error  TYPE ARCH_IDX, "   
lv_object_not_found  TYPE ARCH_IDX, "   
lv_not_authorized  TYPE ARCH_IDX. "   

  CALL FUNCTION 'ARCHIVE_GET_OBJECT_BY_OFFSET'  "
    EXPORTING
         ARCHIVKEY = lv_archivkey
         OFFSET = lv_offset
    IMPORTING
         ARCHIVE_HANDLE = lv_archive_handle
    EXCEPTIONS
        NO_RECORD_FOUND = 1
        FILE_IO_ERROR = 2
        INTERNAL_ERROR = 3
        OPEN_ERROR = 4
        OBJECT_NOT_FOUND = 5
        NOT_AUTHORIZED = 6
. " ARCHIVE_GET_OBJECT_BY_OFFSET




ABAP code using 7.40 inline data declarations to call FM ARCHIVE_GET_OBJECT_BY_OFFSET

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 ARCHIVEKEY FROM ARCH_IDX INTO @DATA(ld_archivkey).
DATA(ld_archivkey) = ' '.
 
"SELECT single TABIX FROM SY INTO @DATA(ld_archive_handle).
 
 
"SELECT single OFFSET FROM ARCH_IDX INTO @DATA(ld_offset).
 
 
 
 
 
 


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!