SAP Function Modules

comments icon Comments

CFX_API_CATEGORY_READ SAP Function module - Read Data of a Category







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

Associated Function Group: CFX_API_CATEGORY
Released Date: 30.01.2004
Processing type: Remote-Enabled
remote enabled module settings


Pattern for FM CFX_API_CATEGORY_READ - CFX API CATEGORY READ 





CALL FUNCTION 'CFX_API_CATEGORY_READ' "Read Data of a Category
  EXPORTING
    i_object_id =               " sysuuid_c     ID of the Categorized cFolders Object
  IMPORTING
    es_fault =                  " cfx_api_ts_fault  Error According to SOAP
    e_faultstring =             " cfx_api_t_faultstring  Short Error Text for User
  TABLES
    et_category_data =          " cfx_api_ts_go_field_value  Values of Fields and Link Lists
    .  "  CFX_API_CATEGORY_READ

ABAP code example for Function Module CFX_API_CATEGORY_READ





The ABAP code below is a full code listing to execute function module CFX_API_CATEGORY_READ 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_es_fault    TYPE CFX_API_TS_FAULT
,
ld_e_faultstring    TYPE CFX_API_T_FAULTSTRING
,
it_et_category_data    TYPE STANDARD TABLE OF CFX_API_TS_GO_FIELD_VALUE,"TABLES PARAM
wa_et_category_data  LIKE LINE OF it_et_category_data
.




DATA(ld_i_object_id) = 'some text here'.
 

"populate fields of struture and append to itab
append wa_et_category_data to it_et_category_data.
.

CALL FUNCTION 'CFX_API_CATEGORY_READ'
  EXPORTING
    i_object_id =                ld_i_object_id
  IMPORTING
    es_fault =                   ld_es_fault
    e_faultstring =              ld_e_faultstring
  TABLES
    et_category_data =           it_et_category_data
    .  "  CFX_API_CATEGORY_READ

IF SY-SUBRC EQ 0.
  "All OK
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_es_fault  TYPE CFX_API_TS_FAULT ,
ld_i_object_id  TYPE SYSUUID_C ,
it_et_category_data  TYPE STANDARD TABLE OF CFX_API_TS_GO_FIELD_VALUE ,
wa_et_category_data  LIKE LINE OF it_et_category_data,
ld_e_faultstring  TYPE CFX_API_T_FAULTSTRING .




ld_i_object_id = 'some text here'. 

"populate fields of struture and append to itab
append wa_et_category_data to it_et_category_data.

SAP Documentation for FM CFX_API_CATEGORY_READ


The category data of the cFolders document with the ID "I_OBJECT_ID" is determined. ...See here for full SAP fm documentation


Contribute (Add Comments)

Please help keep this info upto date and use the comments section below to add useful hints, tips and information specific to this SAP function. This will then be available for you and other users to easily find by simply searching on the object name CFX_API_CATEGORY_READ or its description.


   
 

CFX_API_CATEGORY_READ - Read Data of a Category
CFX_API_CATEGORY_CHANGE_SF - Daten eines Feldes einer Kategorie ändern
CFX_API_CATEGORY_CHANGE - Change Category Data
CFX_API_CATEGORY_ASSIGN - Adds a Category to the Object
CFX_API_AUTHORIZATION_GETDET - x!!!! OBSOLET !!!! siehe Funktionsgruppe CFX_ACO_API_AUTHORIZATION
CFX_API_AUTHORIZATION_CHANGE - x!!!! OBSOLET !!!! siehe Funktionsgruppe CFX_ACO_API_AUTHORIZATION