SAP ALINK_CHECK_DOCUMENT Function Module for









ALINK_CHECK_DOCUMENT is a standard alink check document 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 alink check document FM, simply by entering the name ALINK_CHECK_DOCUMENT into the relevant SAP transaction such as SE37 or SE38.

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



Function ALINK_CHECK_DOCUMENT 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 'ALINK_CHECK_DOCUMENT'"
  EXPORTING
*  PARAMETERS =  "
*  CHECKLINK = 'X' "
*  CHECKMANDT = 'X' "
*  MESSAGETXT =  "
*  MESSAGE = 'X' "

 IMPORTING
   GOON =  "

CHANGING
*  DOC_TYPE = 'PDF' "
   ARCHIV_ID =  "
*  DOCUMENT =  "
*  FLENGTH =  "
*  AR_OBJECT =  "
*  DEL_DATE =  "
*  OBJECT_ID =  "
*  SAP_OBJECT =  "
*  ATTRIBUTS =  "
*  ARC_DOC_ID =  "

TABLES
   BINARCHIVOBJECT =  "

EXCEPTIONS
   FORMAT_ERROR = 1    LINK_ERROR = 2    CLIENT_ERROR = 3
.



IMPORTING Parameters details for ALINK_CHECK_DOCUMENT

PARAMETERS -

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

CHECKLINK -

Data type: CHAR1
Default: 'X'
Optional: Yes
Call by Reference: Yes

CHECKMANDT -

Data type: CHAR1
Default: 'X'
Optional: Yes
Call by Reference: Yes

MESSAGETXT -

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

MESSAGE -

Data type: CHAR1
Default: 'X'
Optional: No
Call by Reference: Yes

EXPORTING Parameters details for ALINK_CHECK_DOCUMENT

GOON -

Data type: C
Optional: No
Call by Reference: Yes

CHANGING Parameters details for ALINK_CHECK_DOCUMENT

DOC_TYPE -

Data type: TOAOM-DOC_TYPE
Default: 'PDF'
Optional: No
Call by Reference: Yes

ARCHIV_ID -

Data type: SAEARCHIVI
Optional: No
Call by Reference: Yes

DOCUMENT -

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

FLENGTH -

Data type: SAPB-LENGTH
Optional: Yes
Call by Reference: Yes

AR_OBJECT -

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

DEL_DATE -

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

OBJECT_ID -

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

SAP_OBJECT -

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

ATTRIBUTS -

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

ARC_DOC_ID -

Data type: TOAV0-ARC_DOC_ID
Optional: Yes
Call by Reference: Yes

TABLES Parameters details for ALINK_CHECK_DOCUMENT

BINARCHIVOBJECT -

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

EXCEPTIONS details

FORMAT_ERROR -

Data type:
Optional: No
Call by Reference: Yes

LINK_ERROR -

Data type:
Optional: No
Call by Reference: Yes

CLIENT_ERROR -

Data type:
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for ALINK_CHECK_DOCUMENT 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_goon  TYPE C, "   
lv_doc_type  TYPE TOAOM-DOC_TYPE, "   'PDF'
lv_parameters  TYPE SDOK_PFTAB, "   
lv_format_error  TYPE SDOK_PFTAB, "   
lt_binarchivobject  TYPE STANDARD TABLE OF TBL1024, "   
lv_archiv_id  TYPE SAEARCHIVI, "   
lv_document  TYPE XSTRING, "   
lv_checklink  TYPE CHAR1, "   'X'
lv_link_error  TYPE CHAR1, "   
lv_flength  TYPE SAPB-LENGTH, "   
lv_checkmandt  TYPE CHAR1, "   'X'
lv_client_error  TYPE CHAR1, "   
lv_ar_object  TYPE SAEOBJART, "   
lv_messagetxt  TYPE STRING, "   
lv_message  TYPE CHAR1, "   'X'
lv_del_date  TYPE SAEDELDATE, "   
lv_object_id  TYPE SAEOBJID, "   
lv_sap_object  TYPE SAEANWDID, "   
lv_attributs  TYPE SDOK_PFTAB, "   
lv_arc_doc_id  TYPE TOAV0-ARC_DOC_ID. "   

  CALL FUNCTION 'ALINK_CHECK_DOCUMENT'  "
    EXPORTING
         PARAMETERS = lv_parameters
         CHECKLINK = lv_checklink
         CHECKMANDT = lv_checkmandt
         MESSAGETXT = lv_messagetxt
         MESSAGE = lv_message
    IMPORTING
         GOON = lv_goon
    CHANGING
         DOC_TYPE = lv_doc_type
         ARCHIV_ID = lv_archiv_id
         DOCUMENT = lv_document
         FLENGTH = lv_flength
         AR_OBJECT = lv_ar_object
         DEL_DATE = lv_del_date
         OBJECT_ID = lv_object_id
         SAP_OBJECT = lv_sap_object
         ATTRIBUTS = lv_attributs
         ARC_DOC_ID = lv_arc_doc_id
    TABLES
         BINARCHIVOBJECT = lt_binarchivobject
    EXCEPTIONS
        FORMAT_ERROR = 1
        LINK_ERROR = 2
        CLIENT_ERROR = 3
. " ALINK_CHECK_DOCUMENT




ABAP code using 7.40 inline data declarations to call FM ALINK_CHECK_DOCUMENT

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 DOC_TYPE FROM TOAOM INTO @DATA(ld_doc_type).
DATA(ld_doc_type) = 'PDF'.
 
 
 
 
 
 
DATA(ld_checklink) = 'X'.
 
 
"SELECT single LENGTH FROM SAPB INTO @DATA(ld_flength).
 
DATA(ld_checkmandt) = 'X'.
 
 
 
 
DATA(ld_message) = 'X'.
 
 
 
 
 
"SELECT single ARC_DOC_ID FROM TOAV0 INTO @DATA(ld_arc_doc_id).
 


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!