SAP SO_FOLDER_DELETE_API1 Function Module for SAPoffice: Delete folder from external location









SO_FOLDER_DELETE_API1 is a standard so folder delete api1 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: Delete folder from external location 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 delete api1 FM, simply by entering the name SO_FOLDER_DELETE_API1 into the relevant SAP transaction such as SE37 or SE38.

Function Group: SOI1
Program Name: SAPLSOI1
Main Program: SAPLSOI1
Appliation area:
Release date: 14-Apr-1998
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function SO_FOLDER_DELETE_API1 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_DELETE_API1'"SAPoffice: Delete folder from external location
  EXPORTING
   FOLDER_ID =  "ID of folder to be deleted
*  PUT_IN_TRASH = 'X' "Flag: Move folder to trash when deleted
*  FORCE_ENTRIES_DELETE =  "Flag: Documents in folder will be deleted

EXCEPTIONS
   FOLDER_NOT_EMPTY = 1    FOLDER_NOT_EXIST = 2    FOLDER_NO_AUTHORIZATION = 3    PARAMETER_ERROR = 4    X_ERROR = 5    ENQUEUE_ERROR = 6
.



IMPORTING Parameters details for SO_FOLDER_DELETE_API1

FOLDER_ID - ID of folder to be deleted

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

PUT_IN_TRASH - Flag: Move folder to trash when deleted

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

FORCE_ENTRIES_DELETE - Flag: Documents in folder will be deleted

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

EXCEPTIONS details

FOLDER_NOT_EMPTY - Specified folder was not empty

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

FOLDER_NOT_EXIST - Specified folder does not exist

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

FOLDER_NO_AUTHORIZATION - No authorization to delete folder

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

PARAMETER_ERROR - Invalid combination of parameter values

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

X_ERROR - Internal error or database inconsistency

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

ENQUEUE_ERROR - Required locks could not be set

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

Copy and paste ABAP code example for SO_FOLDER_DELETE_API1 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_folder_id  TYPE SOOBJINFI1-OBJECT_ID, "   
lv_folder_not_empty  TYPE SOOBJINFI1, "   
lv_put_in_trash  TYPE SONV-FLAG, "   'X'
lv_folder_not_exist  TYPE SONV, "   
lv_force_entries_delete  TYPE SONV-FLAG, "   
lv_folder_no_authorization  TYPE SONV, "   
lv_parameter_error  TYPE SONV, "   
lv_x_error  TYPE SONV, "   
lv_enqueue_error  TYPE SONV. "   

  CALL FUNCTION 'SO_FOLDER_DELETE_API1'  "SAPoffice: Delete folder from external location
    EXPORTING
         FOLDER_ID = lv_folder_id
         PUT_IN_TRASH = lv_put_in_trash
         FORCE_ENTRIES_DELETE = lv_force_entries_delete
    EXCEPTIONS
        FOLDER_NOT_EMPTY = 1
        FOLDER_NOT_EXIST = 2
        FOLDER_NO_AUTHORIZATION = 3
        PARAMETER_ERROR = 4
        X_ERROR = 5
        ENQUEUE_ERROR = 6
. " SO_FOLDER_DELETE_API1




ABAP code using 7.40 inline data declarations to call FM SO_FOLDER_DELETE_API1

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 OBJECT_ID FROM SOOBJINFI1 INTO @DATA(ld_folder_id).
 
 
"SELECT single FLAG FROM SONV INTO @DATA(ld_put_in_trash).
DATA(ld_put_in_trash) = 'X'.
 
 
"SELECT single FLAG FROM SONV INTO @DATA(ld_force_entries_delete).
 
 
 
 
 


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!