HRHAPCN_OBJ_LIB_READ SAP Function module - Read Objective Library Tree

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

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

Pattern for FM HRHAPCN_OBJ_LIB_READ - HRHAPCN OBJ LIB READ

CALL FUNCTION 'HRHAPCN_OBJ_LIB_READ' "Read Objective Library Tree
* EXPORTING
*   plvar =                     " plvar         Plan Version
*   begda = SY-DATUM            " begdatum      Start Date
*   endda = SY-DATUM            " enddatum      End Date
*   all_or_base = 'B'           " syinput       Internal ABAP System Field
*   pup_info = 'X'              " syinput       Internal ABAP System Field
*   update_index = 'X'          " syinput       Internal ABAP System Field
*   depth = 0                   " depth         Display Depth of Structure
*   sort = 'X'                  " syinput       Internal ABAP System Field
*   svect = '1    '             " gdstr-svect   Status Vector
  IMPORTING
    o_tab =                     " hapcn_t_obj_lib  Objective Library Table
    o_without_class =           " hapcn_t_obj_lib  Objective Library Table
  EXCEPTIONS
    ROOT_NOT_FOUND = 1          "               Root object not found
    WEGID_NOT_VALID = 2         "               Evaluation path not found
    .  "  HRHAPCN_OBJ_LIB_READ

ABAP code example for Function Module HRHAPCN_OBJ_LIB_READ

The ABAP code below is a full code listing to execute function module HRHAPCN_OBJ_LIB_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_o_tab  
 
 TYPE HAPCN_T_OBJ_LIB
,
ld_o_without_class  
 
 TYPE HAPCN_T_OBJ_LIB
.


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

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

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

DATA(ld_all_or_base) = 'some text here'.

DATA(ld_pup_info) = 'some text here'.

DATA(ld_update_index) = 'some text here'.

DATA(ld_depth) = 'some text here'.

DATA(ld_sort) = 'some text here'.


DATA(ld_svect) = some text here
.

CALL FUNCTION 'HRHAPCN_OBJ_LIB_READ'
* EXPORTING
*   plvar =                      ld_plvar
*   begda =                      ld_begda
*   endda =                      ld_endda
*   all_or_base =                ld_all_or_base
*   pup_info =                   ld_pup_info
*   update_index =               ld_update_index
*   depth =                      ld_depth
*   sort =                       ld_sort
*   svect =                      ld_svect
  IMPORTING
    o_tab =                      ld_o_tab
    o_without_class =            ld_o_without_class
  EXCEPTIONS
    ROOT_NOT_FOUND =             1
    WEGID_NOT_VALID =            2
    .  "  HRHAPCN_OBJ_LIB_READ

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
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_o_tab
 
 TYPE HAPCN_T_OBJ_LIB ,
ld_plvar
 
 TYPE PLVAR ,
ld_o_without_class
 
 TYPE HAPCN_T_OBJ_LIB ,
ld_begda
 
 TYPE BEGDATUM ,
ld_endda
 
 TYPE ENDDATUM ,
ld_all_or_base
 
 TYPE SYINPUT ,
ld_pup_info
 
 TYPE SYINPUT ,
ld_update_index
 
 TYPE SYINPUT ,
ld_depth
 
 TYPE DEPTH ,
ld_sort
 
 TYPE SYINPUT ,
ld_svect
 
 TYPE GDSTR-SVECT .


ld_plvar = 'some text here'.
ld_begda = 'some text here'.
ld_endda = 'some text here'.
ld_all_or_base = 'some text here'.
ld_pup_info = 'some text here'.
ld_update_index = 'some text here'.
ld_depth = 'some text here'.
ld_sort = 'some text here'.

ld_svect = some text here