SAP SO_FOLDER_LIST_READ Function Module for SAPoffice: Read folders

Search SAP Function Modules

SO_FOLDER_LIST_READ is a standard so folder list read SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for SAPoffice: Read folders 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 so folder list read FM, simply by entering the name SO_FOLDER_LIST_READ into the relevant SAP transaction such as SE37 or SE38.

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

Function SO_FOLDER_LIST_READ 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 'SO_FOLDER_LIST_READ'"SAPoffice: Read folders
  EXPORTING
*  EXCLUDE_REGIONS = ' ' "Exclusion of regions in selection
*  FOLDER_ACCESS = '1' "Access authorization
*  FOLDER_SELECTIONS = ' ' "Entry of selections
*  OWNER = ' ' "Owner
*  REGION = 'Q' "Part of folders (private / shared)
*  SOURCE_FOLDER_ID = ' ' "Root folder ID
*  PARENT_ID = ' ' "
*  CURRENT_FOL_ID = ' ' "

 IMPORTING
   TABLE_EMPTY =  "Table empty = ON, table not empty = OFF
   TABLE_HIER =  "Selections as hierarchy
   TABLE_100_ROWS =  "

TABLES
   FOLDER_LIST =  "Table with all folder hits

EXCEPTIONS
   COMPONENT_NOT_AVAILABLE = 1    OPERATION_NO_AUTHORIZATION = 2    OWNER_NOT_EXIST = 3    PARAMETER_ERROR = 4    X_ERROR = 5 

.

IMPORTING Parameters details for SO_FOLDER_LIST_READ

EXCLUDE_REGIONS - Exclusion of regions in selection

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

FOLDER_ACCESS - Access authorization

Data type: SOFA-USRACC
Default: '1'
Optional: Yes
Call by Reference: No ( called with pass by value option)

FOLDER_SELECTIONS - Entry of selections

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

OWNER - Owner

Data type: SOUD-USRNAM
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

REGION - Part of folders (private / shared)

Data type: SOFD-FOLRG
Default: 'Q'
Optional: Yes
Call by Reference: No ( called with pass by value option)

SOURCE_FOLDER_ID - Root folder ID

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

PARENT_ID -

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

CURRENT_FOL_ID -

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

EXPORTING Parameters details for SO_FOLDER_LIST_READ

TABLE_EMPTY - Table empty = ON, table not empty = OFF

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

TABLE_HIER - Selections as hierarchy

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

TABLE_100_ROWS -

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

TABLES Parameters details for SO_FOLDER_LIST_READ

FOLDER_LIST - Table with all folder hits

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

EXCEPTIONS details

COMPONENT_NOT_AVAILABLE - SAPoffice component not available

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

OPERATION_NO_AUTHORIZATION - No authorization for access

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

OWNER_NOT_EXIST - Owner does not exist

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

PARAMETER_ERROR - Combination of parameter values not allowed

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

X_ERROR - Other error

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

Copy and paste ABAP code example for SO_FOLDER_LIST_READ 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.

ABAP code using 7.40 inline data declarations to call FM SO_FOLDER_LIST_READ

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.

Search for further information about these or an SAP related objects