SAP CFX_API_ALIAS_GETDETAIL Function Module for Read All Attributes of an Alias









CFX_API_ALIAS_GETDETAIL is a standard cfx api alias getdetail SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read All Attributes of an Alias 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 alias getdetail FM, simply by entering the name CFX_API_ALIAS_GETDETAIL into the relevant SAP transaction such as SE37 or SE38.

Function Group: CFX_API_ALIAS
Program Name: SAPLCFX_API_ALIAS
Main Program: SAPLCFX_API_ALIAS
Appliation area:
Release date: 30-Jan-2004
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function CFX_API_ALIAS_GETDETAIL 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_ALIAS_GETDETAIL'"Read All Attributes of an Alias
  EXPORTING
   I_ALIAS_ID =  "Unique ID for the Alias

 IMPORTING
   ES_FAULT =  "Error According to SOAP
   E_FAULTSTRING =  "Short Error Text for User
   E_NAME =  "Name of Alias
   E_DESCRIPTION =  "Alias Description
   E_SHOW =  "Display Alias?
   E_BACKEND_SYSTEM =  "Backend System
   E_INDEX =  "Position of the Alias in the List
   E_AREA_ID =  "ID of Area

TABLES
*  ET_OBJECT_TYPES2 =  "Object Types for Which the Alias Is Used
*  ET_OBJECT_TYPES =  "x !!! OBSOLETE !!!
.



IMPORTING Parameters details for CFX_API_ALIAS_GETDETAIL

I_ALIAS_ID - Unique ID for the Alias

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

EXPORTING Parameters details for CFX_API_ALIAS_GETDETAIL

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)

E_NAME - Name of Alias

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

E_DESCRIPTION - Alias Description

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

E_SHOW - Display Alias?

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

E_BACKEND_SYSTEM - Backend System

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

E_INDEX - Position of the Alias in the List

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

E_AREA_ID - ID of Area

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

TABLES Parameters details for CFX_API_ALIAS_GETDETAIL

ET_OBJECT_TYPES2 - Object Types for Which the Alias Is Used

Data type: CFX_TS_EXTERNAL_ID_NAMESPACE
Optional: Yes
Call by Reference: Yes

ET_OBJECT_TYPES - x !!! OBSOLETE !!!

Data type: CFX_API_TS_OBJECT_TYPE
Optional: Yes
Call by Reference: Yes

Copy and paste ABAP code example for CFX_API_ALIAS_GETDETAIL 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_i_alias_id  TYPE SYSUUID_C, "   
lt_et_object_types2  TYPE STANDARD TABLE OF CFX_TS_EXTERNAL_ID_NAMESPACE, "   
lv_e_faultstring  TYPE CFX_API_T_FAULTSTRING, "   
lt_et_object_types  TYPE STANDARD TABLE OF CFX_API_TS_OBJECT_TYPE, "   
lv_e_name  TYPE STRING, "   
lv_e_description  TYPE STRING, "   
lv_e_show  TYPE CFX_API_T_BOOL, "   
lv_e_backend_system  TYPE STRING, "   
lv_e_index  TYPE I, "   
lv_e_area_id  TYPE SYSUUID_C. "   

  CALL FUNCTION 'CFX_API_ALIAS_GETDETAIL'  "Read All Attributes of an Alias
    EXPORTING
         I_ALIAS_ID = lv_i_alias_id
    IMPORTING
         ES_FAULT = lv_es_fault
         E_FAULTSTRING = lv_e_faultstring
         E_NAME = lv_e_name
         E_DESCRIPTION = lv_e_description
         E_SHOW = lv_e_show
         E_BACKEND_SYSTEM = lv_e_backend_system
         E_INDEX = lv_e_index
         E_AREA_ID = lv_e_area_id
    TABLES
         ET_OBJECT_TYPES2 = lt_et_object_types2
         ET_OBJECT_TYPES = lt_et_object_types
. " CFX_API_ALIAS_GETDETAIL




ABAP code using 7.40 inline data declarations to call FM CFX_API_ALIAS_GETDETAIL

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



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!