GET_ARCHIVE_PARAMETERS SAP Function module

GET_ARCHIVE_PARAMETERS is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name GET_ARCHIVE_PARAMETERS into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: SPRI
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM GET_ARCHIVE_PARAMETERS - GET ARCHIVE PARAMETERS

CALL FUNCTION 'GET_ARCHIVE_PARAMETERS' "
* EXPORTING
*   archive_id = '_'            " arc_params-archiv_id
*   archive_info = '_'          " arc_params-info
*   archive_text = '_'          " arc_params-arctext
*   ar_object = '_'             " arc_params-ar_object
*   in_parameters = SPACE       " arc_params
*   layout = '_'                " arc_params-formular
*   mode = SPACE                "
*   no_dialog = SPACE           "
*   printer = '_'               " arc_params-printer
*   report = '_'                " arc_params-report
*   sap_object = '_'            " arc_params-sap_object
*   abap_list = SPACE           "
*   po_fax_store = SPACE        " pri_params-primm
*   username = SPACE            " syuname
  IMPORTING
    out_parameters =            " arc_params
    valid =                     "               Dialog Cancelled
  EXCEPTIONS
    ARCHIVE_INFO_NOT_FOUND = 1  "
    NO_AUTHORITY = 2            "
    NOT_VALID = 3               "               Dialog Cancelled
    .  "  GET_ARCHIVE_PARAMETERS

ABAP code example for Function Module GET_ARCHIVE_PARAMETERS

The ABAP code below is a full code listing to execute function module GET_ARCHIVE_PARAMETERS including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

DATA:
ld_out_parameters  
 
 TYPE ARC_PARAMS
,
ld_valid  
 
 TYPE STRING
.



DATA(ld_archive_id) = some text here


DATA(ld_archive_info) = some text here


DATA(ld_archive_text) = some text here


DATA(ld_ar_object) = some text here

DATA(ld_in_parameters) = 'Check type of data required'.


DATA(ld_layout) = some text here

DATA(ld_mode) = 'some text here'.

DATA(ld_no_dialog) = 'some text here'.


DATA(ld_printer) = some text here


DATA(ld_report) = some text here


DATA(ld_sap_object) = some text here

DATA(ld_abap_list) = 'some text here'.


DATA(ld_po_fax_store) = some text here

DATA(ld_username) = 'some text here'.
.

CALL FUNCTION 'GET_ARCHIVE_PARAMETERS'
* EXPORTING
*   archive_id =                 ld_archive_id
*   archive_info =               ld_archive_info
*   archive_text =               ld_archive_text
*   ar_object =                  ld_ar_object
*   in_parameters =              ld_in_parameters
*   layout =                     ld_layout
*   mode =                       ld_mode
*   no_dialog =                  ld_no_dialog
*   printer =                    ld_printer
*   report =                     ld_report
*   sap_object =                 ld_sap_object
*   abap_list =                  ld_abap_list
*   po_fax_store =               ld_po_fax_store
*   username =                   ld_username
  IMPORTING
    out_parameters =             ld_out_parameters
    valid =                      ld_valid
  EXCEPTIONS
    ARCHIVE_INFO_NOT_FOUND =     1
    NO_AUTHORITY =               2
    NOT_VALID =                  3
    .  "  GET_ARCHIVE_PARAMETERS

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_out_parameters
 
 TYPE ARC_PARAMS ,
ld_archive_id
 
 TYPE ARC_PARAMS-ARCHIV_ID ,
ld_valid
 
 TYPE STRING ,
ld_archive_info
 
 TYPE ARC_PARAMS-INFO ,
ld_archive_text
 
 TYPE ARC_PARAMS-ARCTEXT ,
ld_ar_object
 
 TYPE ARC_PARAMS-AR_OBJECT ,
ld_in_parameters
 
 TYPE ARC_PARAMS ,
ld_layout
 
 TYPE ARC_PARAMS-FORMULAR ,
ld_mode
 
 TYPE STRING ,
ld_no_dialog
 
 TYPE STRING ,
ld_printer
 
 TYPE ARC_PARAMS-PRINTER ,
ld_report
 
 TYPE ARC_PARAMS-REPORT ,
ld_sap_object
 
 TYPE ARC_PARAMS-SAP_OBJECT ,
ld_abap_list
 
 TYPE STRING ,
ld_po_fax_store
 
 TYPE PRI_PARAMS-PRIMM ,
ld_username
 
 TYPE SYUNAME .



ld_archive_id = some text here

ld_archive_info = some text here

ld_archive_text = some text here

ld_ar_object = some text here
ld_in_parameters = 'some text here'.

ld_layout = some text here
ld_mode = 'some text here'.
ld_no_dialog = 'some text here'.

ld_printer = some text here

ld_report = some text here

ld_sap_object = some text here
ld_abap_list = 'some text here'.

ld_po_fax_store = some text here
ld_username = 'some text here'.