SAP TEXT_ARCHIVE_OBJECT Function Module for Notes text archiving text key for object archiving









TEXT_ARCHIVE_OBJECT is a standard text archive object SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Notes text archiving text key for object archiving 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 text archive object FM, simply by entering the name TEXT_ARCHIVE_OBJECT into the relevant SAP transaction such as SE37 or SE38.

Function Group: STXA
Program Name: SAPLSTXA
Main Program: SAPLSTXA
Appliation area: S
Release date: 18-Jan-1995
Mode(Normal, Remote etc): Normal Function Module
Update:



Function TEXT_ARCHIVE_OBJECT 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 'TEXT_ARCHIVE_OBJECT'"Notes text archiving text key for object archiving
  EXPORTING
   ARCHIVE_HANDLE =  "Archive handle
*  CLIENT = SY-MANDT "Client
   ID =  "Text ID
   LANGUAGE =  "Text Language
   NAME =  "Text Name
   OBJECT =  "Text object
*  OBJECT_DELETE_FLAG = 'X' "Control inform. for delete function (default: delete)

EXCEPTIONS
   WRONG_ACCESS_TO_ARCHIVE = 1
.



IMPORTING Parameters details for TEXT_ARCHIVE_OBJECT

ARCHIVE_HANDLE - Archive handle

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

CLIENT - Client

Data type: SY-MANDT
Default: SY-MANDT
Optional: Yes
Call by Reference: No ( called with pass by value option)

ID - Text ID

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

LANGUAGE - Text Language

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

NAME - Text Name

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

OBJECT - Text object

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

OBJECT_DELETE_FLAG - Control inform. for delete function (default: delete)

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

EXCEPTIONS details

WRONG_ACCESS_TO_ARCHIVE - Archive handle invalid for access

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

Copy and paste ABAP code example for TEXT_ARCHIVE_OBJECT 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_archive_handle  TYPE SY-TABIX, "   
lv_wrong_access_to_archive  TYPE SY, "   
lv_client  TYPE SY-MANDT, "   SY-MANDT
lv_id  TYPE THEAD-TDID, "   
lv_language  TYPE THEAD-TDSPRAS, "   
lv_name  TYPE THEAD-TDNAME, "   
lv_object  TYPE THEAD-TDOBJECT, "   
lv_object_delete_flag  TYPE THEAD. "   'X'

  CALL FUNCTION 'TEXT_ARCHIVE_OBJECT'  "Notes text archiving text key for object archiving
    EXPORTING
         ARCHIVE_HANDLE = lv_archive_handle
         CLIENT = lv_client
         ID = lv_id
         LANGUAGE = lv_language
         NAME = lv_name
         OBJECT = lv_object
         OBJECT_DELETE_FLAG = lv_object_delete_flag
    EXCEPTIONS
        WRONG_ACCESS_TO_ARCHIVE = 1
. " TEXT_ARCHIVE_OBJECT




ABAP code using 7.40 inline data declarations to call FM TEXT_ARCHIVE_OBJECT

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 MANDT FROM SY INTO @DATA(ld_client).
DATA(ld_client) = SY-MANDT.
 
"SELECT single TDID FROM THEAD INTO @DATA(ld_id).
 
"SELECT single TDSPRAS FROM THEAD INTO @DATA(ld_language).
 
"SELECT single TDNAME FROM THEAD INTO @DATA(ld_name).
 
"SELECT single TDOBJECT FROM THEAD INTO @DATA(ld_object).
 
DATA(ld_object_delete_flag) = 'X'.
 


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!