SAP ARCHIVOBJECT_GET_BYTES Function Module for









ARCHIVOBJECT_GET_BYTES is a standard archivobject get bytes 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 archivobject get bytes FM, simply by entering the name ARCHIVOBJECT_GET_BYTES into the relevant SAP transaction such as SE37 or SE38.

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



Function ARCHIVOBJECT_GET_BYTES 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 'ARCHIVOBJECT_GET_BYTES'"
  EXPORTING
   ARCHIV_ID =  "
   ARCHIV_DOC_ID =  "ID of document to be archived
   DOCUMENT_TYPE =  "
   LENGTH =  "
   OFFSET =  "
*  MODE = ' ' "
*  SIGNATURE = 'X' "
*  SHIFT_FLAG = ' ' "
*  COMPID = 'data' "

 IMPORTING
   LENGTH =  "
   OFFSET =  "
   BINLENGTH =  "

TABLES
*  ARCHIVOBJECT =  "
*  BINARCHIVOBJECT =  "

EXCEPTIONS
   ERROR_ARCHIV = 1    ERROR_COMMUNICATIONTABLE = 2    ERROR_KERNEL = 3
.



IMPORTING Parameters details for ARCHIVOBJECT_GET_BYTES

ARCHIV_ID -

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

ARCHIV_DOC_ID - ID of document to be archived

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

DOCUMENT_TYPE -

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

LENGTH -

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

OFFSET -

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

MODE -

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

SIGNATURE -

Data type: TOAOM-AR_STATUS
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

SHIFT_FLAG -

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

COMPID -

Data type: HTTP_API-COMPID
Default: 'data'
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for ARCHIVOBJECT_GET_BYTES

LENGTH -

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

OFFSET -

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

BINLENGTH -

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

TABLES Parameters details for ARCHIVOBJECT_GET_BYTES

ARCHIVOBJECT -

Data type: DOCS
Optional: Yes
Call by Reference: Yes

BINARCHIVOBJECT -

Data type: TBL1024
Optional: Yes
Call by Reference: Yes

EXCEPTIONS details

ERROR_ARCHIV - Error from Archive System

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

ERROR_COMMUNICATIONTABLE -

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

ERROR_KERNEL - Error from SAP Kernel

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

Copy and paste ABAP code example for ARCHIVOBJECT_GET_BYTES 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_length  TYPE SAPB-LENGTH, "   
lv_archiv_id  TYPE TOAAR-ARCHIV_ID, "   
lt_archivobject  TYPE STANDARD TABLE OF DOCS, "   
lv_error_archiv  TYPE DOCS, "   
lv_offset  TYPE SAPB-OFFSET, "   
lv_archiv_doc_id  TYPE SAPB-SAPADOKID, "   
lt_binarchivobject  TYPE STANDARD TABLE OF TBL1024, "   
lv_error_communicationtable  TYPE TBL1024, "   
lv_binlength  TYPE SAPB-LENGTH, "   
lv_error_kernel  TYPE SAPB, "   
lv_document_type  TYPE TOADD-DOC_TYPE, "   
lv_length  TYPE SAPB-LENGTH, "   
lv_offset  TYPE SAPB-OFFSET, "   
lv_mode  TYPE C, "   SPACE
lv_signature  TYPE TOAOM-AR_STATUS, "   'X'
lv_shift_flag  TYPE C, "   SPACE
lv_compid  TYPE HTTP_API-COMPID. "   'data'

  CALL FUNCTION 'ARCHIVOBJECT_GET_BYTES'  "
    EXPORTING
         ARCHIV_ID = lv_archiv_id
         ARCHIV_DOC_ID = lv_archiv_doc_id
         DOCUMENT_TYPE = lv_document_type
         LENGTH = lv_length
         OFFSET = lv_offset
         MODE = lv_mode
         SIGNATURE = lv_signature
         SHIFT_FLAG = lv_shift_flag
         COMPID = lv_compid
    IMPORTING
         LENGTH = lv_length
         OFFSET = lv_offset
         BINLENGTH = lv_binlength
    TABLES
         ARCHIVOBJECT = lt_archivobject
         BINARCHIVOBJECT = lt_binarchivobject
    EXCEPTIONS
        ERROR_ARCHIV = 1
        ERROR_COMMUNICATIONTABLE = 2
        ERROR_KERNEL = 3
. " ARCHIVOBJECT_GET_BYTES




ABAP code using 7.40 inline data declarations to call FM ARCHIVOBJECT_GET_BYTES

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 LENGTH FROM SAPB INTO @DATA(ld_length).
 
"SELECT single ARCHIV_ID FROM TOAAR INTO @DATA(ld_archiv_id).
 
 
 
"SELECT single OFFSET FROM SAPB INTO @DATA(ld_offset).
 
"SELECT single SAPADOKID FROM SAPB INTO @DATA(ld_archiv_doc_id).
 
 
 
"SELECT single LENGTH FROM SAPB INTO @DATA(ld_binlength).
 
 
"SELECT single DOC_TYPE FROM TOADD INTO @DATA(ld_document_type).
 
"SELECT single LENGTH FROM SAPB INTO @DATA(ld_length).
 
"SELECT single OFFSET FROM SAPB INTO @DATA(ld_offset).
 
DATA(ld_mode) = ' '.
 
"SELECT single AR_STATUS FROM TOAOM INTO @DATA(ld_signature).
DATA(ld_signature) = 'X'.
 
DATA(ld_shift_flag) = ' '.
 
"SELECT single COMPID FROM HTTP_API INTO @DATA(ld_compid).
DATA(ld_compid) = 'data'.
 


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!