BAL_LOG_MSG_ADD SAP Function module - Application Log: Log: Message: Add

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

Associated Function Group: SBAL
Released Date: 26.04.1999
Processing type: Normal fucntion module

Pattern for FM BAL_LOG_MSG_ADD - BAL LOG MSG ADD

CALL FUNCTION 'BAL_LOG_MSG_ADD' "Application Log: Log: Message: Add
  EXPORTING
*   i_log_handle =              " balloghndl    Log handle
    i_s_msg =                   " bal_s_msg     Notification data
  IMPORTING
    e_s_msg_handle =            " balmsghndl    Message handle
    e_msg_was_logged =          " boolean       Message collected
    e_msg_was_displayed =       " boolean       Message output
  EXCEPTIONS
    LOG_NOT_FOUND = 1           "               Log not found
    MSG_INCONSISTENT = 2        "               Message inconsistent
    LOG_IS_FULL = 3             "               Message number 999999 reached. Log is full
    .  "  BAL_LOG_MSG_ADD

ABAP code example for Function Module BAL_LOG_MSG_ADD

The ABAP code below is a full code listing to execute function module BAL_LOG_MSG_ADD 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_e_s_msg_handle  
 
 TYPE BALMSGHNDL
,
ld_e_msg_was_logged  
 
 TYPE BOOLEAN
,
ld_e_msg_was_displayed  
 
 TYPE BOOLEAN
.


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

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

CALL FUNCTION 'BAL_LOG_MSG_ADD'
  EXPORTING
*   i_log_handle =               ld_i_log_handle
    i_s_msg =                    ld_i_s_msg
  IMPORTING
    e_s_msg_handle =             ld_e_s_msg_handle
    e_msg_was_logged =           ld_e_msg_was_logged
    e_msg_was_displayed =        ld_e_msg_was_displayed
  EXCEPTIONS
    LOG_NOT_FOUND =              1
    MSG_INCONSISTENT =           2
    LOG_IS_FULL =                3
    .  "  BAL_LOG_MSG_ADD

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
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_e_s_msg_handle
 
 TYPE BALMSGHNDL ,
ld_i_log_handle
 
 TYPE BALLOGHNDL ,
ld_e_msg_was_logged
 
 TYPE BOOLEAN ,
ld_i_s_msg
 
 TYPE BAL_S_MSG ,
ld_e_msg_was_displayed
 
 TYPE BOOLEAN .


ld_i_log_handle = 'Check type of data required'.
ld_i_s_msg = 'Check type of data required'.

SAP Documentation for FM BAL_LOG_MSG_ADD

Message collection methods