MSS_GET_CLUSTERED_INDEX SAP Function module

MSS_GET_CLUSTERED_INDEX 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 MSS_GET_CLUSTERED_INDEX into the relevant SAP transaction such as SE37 or SE80.

Associated Function Group: SFMSS_SYSCAT
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM MSS_GET_CLUSTERED_INDEX - MSS GET CLUSTERED INDEX

CALL FUNCTION 'MSS_GET_CLUSTERED_INDEX' "
  EXPORTING
    table_name =                " msstable      Table Name
*   schema_name =               " mssschema     Structure name
*   db_name =                   " mssdb         Database Name
  IMPORTING
    clus_index =                " mssindex
  EXCEPTIONS
    NOT_RUNNING_ON_MSSQL = 1    "
    DB_ERROR = 2                "
    INTERNAL_ERROR = 3          "
    DB_NOT_FOUND = 4            "
    NO_DB_ACCESS = 5            "
    SCHEMA_NOT_FOUND = 6        "
    INVALID_INPUT = 7           "
    TABLE_NOT_FOUND = 8         "
    INDEX_NOT_FOUND = 9         "
    .  "  MSS_GET_CLUSTERED_INDEX

ABAP code example for Function Module MSS_GET_CLUSTERED_INDEX

The ABAP code below is a full code listing to execute function module MSS_GET_CLUSTERED_INDEX 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_clus_index  
 
 TYPE MSSINDEX
.


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

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

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

CALL FUNCTION 'MSS_GET_CLUSTERED_INDEX'
  EXPORTING
    table_name =                 ld_table_name
*   schema_name =                ld_schema_name
*   db_name =                    ld_db_name
  IMPORTING
    clus_index =                 ld_clus_index
  EXCEPTIONS
    NOT_RUNNING_ON_MSSQL =       1
    DB_ERROR =                   2
    INTERNAL_ERROR =             3
    DB_NOT_FOUND =               4
    NO_DB_ACCESS =               5
    SCHEMA_NOT_FOUND =           6
    INVALID_INPUT =              7
    TABLE_NOT_FOUND =            8
    INDEX_NOT_FOUND =            9
    .  "  MSS_GET_CLUSTERED_INDEX

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
ELSEIF SY-SUBRC EQ 6. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 7. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 8. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 9. "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_clus_index
 
 TYPE MSSINDEX ,
ld_table_name
 
 TYPE MSSTABLE ,
ld_schema_name
 
 TYPE MSSSCHEMA ,
ld_db_name
 
 TYPE MSSDB .


ld_table_name = 'Check type of data required'.
ld_schema_name = 'Check type of data required'.
ld_db_name = 'Check type of data required'.