SAP ARCHIVOBJECT_GET_CLIENT Function Module for









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

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



Function ARCHIVOBJECT_GET_CLIENT 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_CLIENT'"
EXPORTING
ARCHIV_DOC_ID = "Identifier of document to be displayed
* ARCHIV_DOC_INDEX = ' ' "
ARCHIV_ID = "Identification of the archive
* PATH = "
* SIGN = ' ' "
* DOC_TYPE = ' ' "
* PATH255 = ' ' "

IMPORTING
REPATH = "
COUNT = "
FILE_NAMES = "
REPATH255 = "

EXCEPTIONS
ERROR_ARCHIV = 1 ERROR_COMMUNICATIONTABLE = 2 ERROR_KERNEL = 3 ERROR_HTTP = 4
.



IMPORTING Parameters details for ARCHIVOBJECT_GET_CLIENT

ARCHIV_DOC_ID - Identifier of document to be displayed

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

ARCHIV_DOC_INDEX -

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

ARCHIV_ID - Identification of the archive

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

PATH -

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

SIGN -

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

DOC_TYPE -

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

PATH255 -

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

EXPORTING Parameters details for ARCHIVOBJECT_GET_CLIENT

REPATH -

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

COUNT -

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

FILE_NAMES -

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

REPATH255 -

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

EXCEPTIONS details

ERROR_ARCHIV -

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 -

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

ERROR_HTTP -

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

Copy and paste ABAP code example for ARCHIVOBJECT_GET_CLIENT 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_repath  TYPE SAPB-SAPPFAD, "   
lv_error_archiv  TYPE SAPB, "   
lv_archiv_doc_id  TYPE SAPB-SAPADOKID, "   
lv_count  TYPE P, "   
lv_archiv_doc_index  TYPE SAPB-SAPADOKID, "   SPACE
lv_error_communicationtable  TYPE SAPB, "   
lv_archiv_id  TYPE TOAAR-ARCHIV_ID, "   
lv_file_names  TYPE SAPB-SAPFILES, "   
lv_error_kernel  TYPE SAPB, "   
lv_path  TYPE SAPB-SAPPFAD, "   
lv_repath255  TYPE CHAR255, "   
lv_error_http  TYPE CHAR255, "   
lv_sign  TYPE SAPB-SAPBZZ, "   SPACE
lv_doc_type  TYPE TOADV-DOC_TYPE, "   SPACE
lv_path255  TYPE CHAR255. "   SPACE

  CALL FUNCTION 'ARCHIVOBJECT_GET_CLIENT'  "
    EXPORTING
         ARCHIV_DOC_ID = lv_archiv_doc_id
         ARCHIV_DOC_INDEX = lv_archiv_doc_index
         ARCHIV_ID = lv_archiv_id
         PATH = lv_path
         SIGN = lv_sign
         DOC_TYPE = lv_doc_type
         PATH255 = lv_path255
    IMPORTING
         REPATH = lv_repath
         COUNT = lv_count
         FILE_NAMES = lv_file_names
         REPATH255 = lv_repath255
    EXCEPTIONS
        ERROR_ARCHIV = 1
        ERROR_COMMUNICATIONTABLE = 2
        ERROR_KERNEL = 3
        ERROR_HTTP = 4
. " ARCHIVOBJECT_GET_CLIENT




ABAP code using 7.40 inline data declarations to call FM ARCHIVOBJECT_GET_CLIENT

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 SAPPFAD FROM SAPB INTO @DATA(ld_repath).
 
 
"SELECT single SAPADOKID FROM SAPB INTO @DATA(ld_archiv_doc_id).
 
 
"SELECT single SAPADOKID FROM SAPB INTO @DATA(ld_archiv_doc_index).
DATA(ld_archiv_doc_index) = ' '.
 
 
"SELECT single ARCHIV_ID FROM TOAAR INTO @DATA(ld_archiv_id).
 
"SELECT single SAPFILES FROM SAPB INTO @DATA(ld_file_names).
 
 
"SELECT single SAPPFAD FROM SAPB INTO @DATA(ld_path).
 
 
 
"SELECT single SAPBZZ FROM SAPB INTO @DATA(ld_sign).
DATA(ld_sign) = ' '.
 
"SELECT single DOC_TYPE FROM TOADV INTO @DATA(ld_doc_type).
DATA(ld_doc_type) = ' '.
 
DATA(ld_path255) = ' '.
 


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!