SAP CFX_API_FOLDER_GETSTRUCTURE Function Module for Attribute von Mappen und Mappenobjekten lesen









CFX_API_FOLDER_GETSTRUCTURE is a standard cfx api folder 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 von Mappen und Mappenobjekten 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 folder getstructure FM, simply by entering the name CFX_API_FOLDER_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_FOLDER_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_FOLDER_GETSTRUCTURE'"Attribute von Mappen und Mappenobjekten lesen
EXPORTING
IT_FOLDER_IDS = "Folder IDs
* I_BACKEND_SYSTEM = "Namespace for Aliases
* I_ALIAS_LOOKUP_DEPTH = "Search Depth for Aliases
* I_FOLDER_LOOKUP_DEPTH = 2 "Search Depth for Folders
* I_DOC_LOOKUP_DEPTH = 2 "Search Depth for Folder Objects (Documents)

IMPORTING
ES_FAULT = "Error According to SOAP
E_FAULTSTRING = "Short Error Text for User
ET_FOLDERS = "Attributes from Folders
.



IMPORTING Parameters details for CFX_API_FOLDER_GETSTRUCTURE

IT_FOLDER_IDS - Folder IDs

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

I_BACKEND_SYSTEM - Namespace for Aliases

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

I_ALIAS_LOOKUP_DEPTH - Search Depth for Aliases

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

I_FOLDER_LOOKUP_DEPTH - Search Depth for Folders

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

I_DOC_LOOKUP_DEPTH - Search Depth for Folder Objects (Documents)

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

EXPORTING Parameters details for CFX_API_FOLDER_GETSTRUCTURE

ES_FAULT - Error According to SOAP

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

E_FAULTSTRING - Short Error Text for User

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

ET_FOLDERS - Attributes from Folders

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

Copy and paste ABAP code example for CFX_API_FOLDER_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_folder_ids  TYPE CFX_API_TT_ID, "   
lv_e_faultstring  TYPE CFX_API_T_FAULTSTRING, "   
lv_i_backend_system  TYPE STRING, "   
lv_et_folders  TYPE CFX_API_TT_FOLDER, "   
lv_i_alias_lookup_depth  TYPE I, "   
lv_i_folder_lookup_depth  TYPE I, "   2
lv_i_doc_lookup_depth  TYPE I. "   2

  CALL FUNCTION 'CFX_API_FOLDER_GETSTRUCTURE'  "Attribute von Mappen und Mappenobjekten lesen
    EXPORTING
         IT_FOLDER_IDS = lv_it_folder_ids
         I_BACKEND_SYSTEM = lv_i_backend_system
         I_ALIAS_LOOKUP_DEPTH = lv_i_alias_lookup_depth
         I_FOLDER_LOOKUP_DEPTH = lv_i_folder_lookup_depth
         I_DOC_LOOKUP_DEPTH = lv_i_doc_lookup_depth
    IMPORTING
         ES_FAULT = lv_es_fault
         E_FAULTSTRING = lv_e_faultstring
         ET_FOLDERS = lv_et_folders
. " CFX_API_FOLDER_GETSTRUCTURE




ABAP code using 7.40 inline data declarations to call FM CFX_API_FOLDER_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_folder_lookup_depth) = 2.
 
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!