Fonction SAP ARCHIVE_GET_NEXT_OBJECT - Read Data Object from the Archive File

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
ARCHIVE_HANDLE SYST-TABIX I 4 Handle to the Open Archive

Paramètre Reférence Type Long. Description
ARCHIVE_NAME HEADA-ARKEY C 20 Archive Key According to Archive Management
COMPR_OBJECT_LENGTH I I 4 Data Object Length (Compressed)
OBJECT_ID 0 Identification of the Read Data Object
OBJECT_OFFSET ARCH_IDX-OFFSET I 4 Offset of Data Object in the Archive
SESSION ADMI_RUN_D N 6 Archiving Session ID

Exception Description
END_OF_FILE End of the Archive File Reached
FILE_IO_ERROR Archive File Access Error
INTERNAL_ERROR Internal Error
OPEN_ERROR Archive File Open Error
WRONG_ACCESS_TO_ARCHIVE Incorrect Access to the Archive

Functionality
This function module reads the next data object for an archive handlefrom an archive which has been opened for reading.
The data which belongs to an archiving class is forwarded automaticallyto the relevant archiving class. This means that the data can beretrieved from the archiving class immediately after this functionmodule has been called. Typical archiving classes are long texts andchange documents.
Only when a data object has been read from an archive is it possible toaccess the data using function modules ARCHIVE_GET_NEXT_RECORD
and ARCHIVE_GET_NEXT_STRUCT_SPECIF .

  • Example 1

    • DATA: HANDLE LIKE SY_TABIX.
    ...
    CALL FUNCTION 'ARCHIVE_GET_NEXT_OBJECT'
    EXPORTING
    ARCHIVE_HANDLE = HANDLE
    EXCEPTIONS
    END_OF_FILE = 01
    FILE_IO_ERROR = 02
    INTERNAL_ERROR = 03
    OPEN_ERROR = 04
    WRONG_ACCESS_TO_ARCHIVE = 05.
    • Example 2

      • A detailed example can be found in program RSARCH05.

      Notes
      The same function is performed implicitly in this function module as inthe function module ARCHIVE_OPEN_FOR_READ since a new archivefile is opened automatically for reading when the current file has beenread completely. This also means that the same exceptions can be raisedas in the function module ARCHIVE_OPEN_FOR_READ. Take this intoaccount in your programs.
      The parameter ARCHIVE_NAME returns the name of the archive whichis being processed with the handle.
      This value can change for each handle at runtime because the archivingcan manage several archive files per handle. The current value isalways returned.

      Description
      Length of a data object in bytes (in its compressed archive fileformat).

      Description
      You receive the ID of the data object read via this parameter. This IDwas specified via the function module ARCHIVE_NEW_OBJECT whenthe archive was generated.

      Description
      The parameter OBJECT_OFFSET displays the address of the currentdata object in bytes. With the function moduleARCHIVE_ADMIN_SAVE_INDEX this address can be stored in the indextable ARCH_IDX in order to enable direct access to the archiveddata object.

      Description
      This parameter identifies the archiving session that archived the dataobject that has just been read.
      Eine Auswertung des Parameters erlaubt es, Informationen, die sichwärend eines Laufs nicht ändern, nur bei Laufwechsel zu ermitteln.
      Analyzing this parameter enables you to obtain information (that doesnot change during a session) when changing sessions only.
      INCLUDE 'ARCHIVE_PARAM_HANDLE_READ' OBJECT DOKU ID TX
      Note that in reload programs, only the read handle can be used in thiscontext.

543936Incorrect selection version displayed in Archive Info Syst.