SAP ARCHIVES_KEY_RETURN Function Module for Archiving: Returns archive key

Search SAP Function Modules

ARCHIVES_KEY_RETURN is a standard archives key return SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Archiving: Returns archive key 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 archives key return FM, simply by entering the name ARCHIVES_KEY_RETURN into the relevant SAP transaction such as SE37 or SE38.

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

Function ARCHIVES_KEY_RETURN 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 'ARCHIVES_KEY_RETURN'"Archiving: Returns archive key
  EXPORTING
   I_APPLI =  "Application
   I_OBJCT =  "Archiving object

TABLES
   T_ARKEY =  "Table: Archive key, reorg file name
   T_FR01S =  "Table: Select options and parameters

EXCEPTIONS
   ERROR_GET = 1    ERROR_TR01 = 2    NO_KEY_SELECTED = 3 

.

IMPORTING Parameters details for ARCHIVES_KEY_RETURN

I_APPLI - Application

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

I_OBJCT - Archiving object

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

TABLES Parameters details for ARCHIVES_KEY_RETURN

T_ARKEY - Table: Archive key, reorg file name

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

T_FR01S - Table: Select options and parameters

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

EXCEPTIONS details

ERROR_GET - Error in reading management data:

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

ERROR_TR01 - Entry was not found in TR01

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

NO_KEY_SELECTED - No active archive key selected

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

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

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