SAP ARCHIVE_GET_WITH_CURSOR Function Module for Archiving Object: Read Data Record from Data Object at Pointer
ARCHIVE_GET_WITH_CURSOR is a standard archive get with cursor 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 Object: Read Data Record from Data Object at Pointer 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 with cursor FM, simply by entering the name ARCHIVE_GET_WITH_CURSOR 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_WITH_CURSOR 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_WITH_CURSOR'"Archiving Object: Read Data Record from Data Object at Pointer.
EXPORTING
ARCHIVE_HANDLE = "Handle to the Open Archive Files
RECORD_CURSOR = "Pointer to Data Record
* GET_REAL_STRUCTURE_NAME = 'X' "Conversion of the Structure Name
* AUTOMATIC_CONVERSION = 'X' "Automatic Conversion of the Data Record
IMPORTING
RECORD = "Data Record
RECORD_FLAGS = "Flag Bar per Data Record
RECORD_STRUCTURE = "Name of Returned Structure
RECORD_LENGTH = "Length of the Archive Record in Parameter RECORD
RECORD_REF = "Reference to Data Record
EXCEPTIONS
INTERNAL_ERROR = 1 WRONG_ACCESS_TO_ARCHIVE = 2 WRONG_CURSOR = 3
IMPORTING Parameters details for ARCHIVE_GET_WITH_CURSOR
ARCHIVE_HANDLE - Handle to the Open Archive Files
Data type: SY-TABIXOptional: No
Call by Reference: No ( called with pass by value option)
RECORD_CURSOR - Pointer to Data Record
Data type: SY-TABIXOptional: 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_WITH_CURSOR
RECORD - Data Record
Data type:Optional: No
Call by Reference: No ( called with pass by value option)
RECORD_FLAGS - Flag Bar per Data Record
Data type: ARC_BUFFER-FLAGSOptional: No
Call by Reference: No ( called with pass by value option)
RECORD_STRUCTURE - Name of Returned Structure
Data type: ARCH_DEF-SONOptional: No
Call by Reference: No ( called with pass by value option)
RECORD_LENGTH - Length of the Archive Record in Parameter RECORD
Data type: ARCH_INT-INT4Optional: No
Call by Reference: No ( called with pass by value option)
RECORD_REF - Reference to Data Record
Data type: DATAOptional: No
Call by Reference: Yes
EXCEPTIONS details
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)
WRONG_CURSOR - Incorrect Value in Cursor
Data type:Optional: No
Call by Reference: No ( called with pass by value option)
Copy and paste ABAP code example for ARCHIVE_GET_WITH_CURSOR 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_archive_handle | TYPE SY-TABIX, " | |||
lv_internal_error | TYPE SY, " | |||
lv_record_flags | TYPE ARC_BUFFER-FLAGS, " | |||
lv_record_cursor | TYPE SY-TABIX, " | |||
lv_wrong_access_to_archive | TYPE SY, " | |||
lv_wrong_cursor | TYPE SY, " | |||
lv_record_structure | TYPE ARCH_DEF-SON, " | |||
lv_get_real_structure_name | TYPE ARCH_DEF, " 'X' | |||
lv_record_length | TYPE ARCH_INT-INT4, " | |||
lv_automatic_conversion | TYPE ARCH_INT, " 'X' | |||
lv_record_ref | TYPE DATA. " |
  CALL FUNCTION 'ARCHIVE_GET_WITH_CURSOR' "Archiving Object: Read Data Record from Data Object at Pointer |
EXPORTING | ||
ARCHIVE_HANDLE | = lv_archive_handle | |
RECORD_CURSOR | = lv_record_cursor | |
GET_REAL_STRUCTURE_NAME | = lv_get_real_structure_name | |
AUTOMATIC_CONVERSION | = lv_automatic_conversion | |
IMPORTING | ||
RECORD | = lv_record | |
RECORD_FLAGS | = lv_record_flags | |
RECORD_STRUCTURE | = lv_record_structure | |
RECORD_LENGTH | = lv_record_length | |
RECORD_REF | = lv_record_ref | |
EXCEPTIONS | ||
INTERNAL_ERROR = 1 | ||
WRONG_ACCESS_TO_ARCHIVE = 2 | ||
WRONG_CURSOR = 3 | ||
. " ARCHIVE_GET_WITH_CURSOR |
ABAP code using 7.40 inline data declarations to call FM ARCHIVE_GET_WITH_CURSOR
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 FLAGS FROM ARC_BUFFER INTO @DATA(ld_record_flags). | ||||
"SELECT single TABIX FROM SY INTO @DATA(ld_record_cursor). | ||||
"SELECT single SON FROM ARCH_DEF INTO @DATA(ld_record_structure). | ||||
DATA(ld_get_real_structure_name) | = 'X'. | |||
"SELECT single INT4 FROM ARCH_INT INTO @DATA(ld_record_length). | ||||
DATA(ld_automatic_conversion) | = 'X'. | |||
Search for further information about these or an SAP related objects