SRM_DOCUMENT_DELETE SAP Function module - SRM: Set Document Attributes

SRM_DOCUMENT_DELETE is a standard SAP function module available within R/3 SAP systems depending on your version and release level. Below is the pattern details for this FM showing its interface including any import and export parameters, exceptions etc as well as any documentation contributions (Comments) specific to the object.

See here to view full function module documentation and code listing, simply by entering the name SRM_DOCUMENT_DELETE into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: SRM_BAPI_DOCUMENT
Released Date: Not Released
Processing type: Remote-Enabled

Pattern for FM SRM_DOCUMENT_DELETE - SRM DOCUMENT DELETE

CALL FUNCTION 'SRM_DOCUMENT_DELETE' "SRM: Set Document Attributes
  EXPORTING
    objectid =                  " bapisrmdoc-guid  Internal Document ID
    documentclass =             " bapisrmdoc-docclass  Location of Document
    whole_document =            " bapisrmdoc-boolean  'X': All Versions; ' ': Only Specified Version
*   version = 0                 " bapisrmdoc-version  Physical Version Number
*   do_commit =                 " bapisrmdoc-boolean  'X': Commit after Changing Attribute
*   doc_context =               " bapidoccontext  Access Context: RMS ID and SPS ID
  IMPORTING
    return =                    " bapiret2      Return Parameter
  EXCEPTIONS
    INTERNAL_ERROR = 1          "               Internal Error
    PARAMETER_ERROR = 2         "               Parameter error
    NOT_AUTHORIZED = 3          "               No Authorization
    DOC_NOT_FOUND = 4           "               Document Not Found
    YET_LOCKED = 5              "               Document locked by other user
    .  "  SRM_DOCUMENT_DELETE

ABAP code example for Function Module SRM_DOCUMENT_DELETE

The ABAP code below is a full code listing to execute function module SRM_DOCUMENT_DELETE including all data declarations. The code uses 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 original method of declaring data variables up front. 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).

DATA:
ld_return  
 
 TYPE BAPIRET2
.



DATA(ld_objectid) = some text here


DATA(ld_documentclass) = some text here


DATA(ld_whole_document) = some text here


DATA(ld_version) = 123 


DATA(ld_do_commit) = some text here

DATA(ld_doc_context) = 'Check type of data required'.
.

CALL FUNCTION 'SRM_DOCUMENT_DELETE'
  EXPORTING
    objectid =                   ld_objectid
    documentclass =              ld_documentclass
    whole_document =             ld_whole_document
*   version =                    ld_version
*   do_commit =                  ld_do_commit
*   doc_context =                ld_doc_context
  IMPORTING
    return =                     ld_return
  EXCEPTIONS
    INTERNAL_ERROR =             1
    PARAMETER_ERROR =            2
    NOT_AUTHORIZED =             3
    DOC_NOT_FOUND =              4
    YET_LOCKED =                 5
    .  "  SRM_DOCUMENT_DELETE

IF SY-SUBRC EQ 0.
  "All OK
ELSEIF SY-SUBRC EQ 1. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 2. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 4. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 5. "Exception
  "Add code for exception here
ENDIF.

ABAP code to compare 7.40 inline data declaration with original syntax

The below ABAP code uses the older none in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. It may also be useful if you are using an older version of SAP as some of the newer syntax above, such as the @DATA is not available until 4.70 EHP 8.

DATA:

ld_return
 
 TYPE BAPIRET2 ,
ld_objectid
 
 TYPE BAPISRMDOC-GUID ,
ld_documentclass
 
 TYPE BAPISRMDOC-DOCCLASS ,
ld_whole_document
 
 TYPE BAPISRMDOC-BOOLEAN ,
ld_version
 
 TYPE BAPISRMDOC-VERSION ,
ld_do_commit
 
 TYPE BAPISRMDOC-BOOLEAN ,
ld_doc_context
 
 TYPE BAPIDOCCONTEXT .



ld_objectid = some text here

ld_documentclass = some text here

ld_whole_document = some text here

ld_version = 123 

ld_do_commit = some text here
ld_doc_context = 'Check type of data required'.

SAP Documentation for FM SRM_DOCUMENT_DELETE