SAP CFX_API_DOC_GETSTRUCTURE Function Module for Attribute der Versionen eines Dokumentes lesen









CFX_API_DOC_GETSTRUCTURE is a standard cfx api doc getstructure SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Attribute der Versionen eines Dokumentes lesen 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 cfx api doc getstructure FM, simply by entering the name CFX_API_DOC_GETSTRUCTURE into the relevant SAP transaction such as SE37 or SE38.

Function Group: CFX_UI_API
Program Name: SAPLCFX_UI_API
Main Program: SAPLCFX_UI_API
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function CFX_API_DOC_GETSTRUCTURE 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 'CFX_API_DOC_GETSTRUCTURE'"Attribute der Versionen eines Dokumentes lesen
EXPORTING
IT_DOC_IDS = "IDs der Mappenobjekte (Dokumente)
* I_DOC_LOOKUP_DEPTH = 2 "Suchtiefe für Mappenobjekte
* I_BACKEND_SYSTEM = "Namensraum für Aliasse
* I_ALIAS_LOOKUP_DEPTH = "Suchtiefe für Aliasse

IMPORTING
ES_FAULT = "Fehler in Anlehnung an SOAP
E_FAULTSTRING = "Kurzer Fehlertext für Anwender
ET_DOCS = "Attribute von Mappenobjekten
.



IMPORTING Parameters details for CFX_API_DOC_GETSTRUCTURE

IT_DOC_IDS - IDs der Mappenobjekte (Dokumente)

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

I_DOC_LOOKUP_DEPTH - Suchtiefe für Mappenobjekte

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

I_BACKEND_SYSTEM - Namensraum für Aliasse

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

I_ALIAS_LOOKUP_DEPTH - Suchtiefe für Aliasse

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

EXPORTING Parameters details for CFX_API_DOC_GETSTRUCTURE

ES_FAULT - Fehler in Anlehnung an SOAP

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

E_FAULTSTRING - Kurzer Fehlertext für Anwender

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

ET_DOCS - Attribute von Mappenobjekten

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

Copy and paste ABAP code example for CFX_API_DOC_GETSTRUCTURE 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_es_fault  TYPE CFX_API_TS_FAULT, "   
lv_it_doc_ids  TYPE CFX_API_TT_ID, "   
lv_e_faultstring  TYPE CFX_API_T_FAULTSTRING, "   
lv_i_doc_lookup_depth  TYPE I, "   2
lv_et_docs  TYPE CFX_API_TT_DOC, "   
lv_i_backend_system  TYPE STRING, "   
lv_i_alias_lookup_depth  TYPE I. "   

  CALL FUNCTION 'CFX_API_DOC_GETSTRUCTURE'  "Attribute der Versionen eines Dokumentes lesen
    EXPORTING
         IT_DOC_IDS = lv_it_doc_ids
         I_DOC_LOOKUP_DEPTH = lv_i_doc_lookup_depth
         I_BACKEND_SYSTEM = lv_i_backend_system
         I_ALIAS_LOOKUP_DEPTH = lv_i_alias_lookup_depth
    IMPORTING
         ES_FAULT = lv_es_fault
         E_FAULTSTRING = lv_e_faultstring
         ET_DOCS = lv_et_docs
. " CFX_API_DOC_GETSTRUCTURE




ABAP code using 7.40 inline data declarations to call FM CFX_API_DOC_GETSTRUCTURE

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.

 
 
 
DATA(ld_i_doc_lookup_depth) = 2.
 
 
 
 


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!