SAP ICLX_QUERY_PARTICIPANT_IN Function Module for API 'Search for Participants'









ICLX_QUERY_PARTICIPANT_IN is a standard iclx query participant in SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for API 'Search for Participants' 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 iclx query participant in FM, simply by entering the name ICLX_QUERY_PARTICIPANT_IN into the relevant SAP transaction such as SE37 or SE38.

Function Group: ICLX_PARTICIPANT_IN
Program Name: SAPLICLX_PARTICIPANT_IN
Main Program: SAPLICLX_PARTICIPANT_IN
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function ICLX_QUERY_PARTICIPANT_IN 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 'ICLX_QUERY_PARTICIPANT_IN'"API 'Search for Participants'
EXPORTING
* IV_FILL_FIELD_DESCR = 'X' "
* IV_MAX_RECORDS = '50' "
* IV_LANGUAGE_ISO = "Language According to ISO 639

IMPORTING
EV_SUBRC = "Return Value from ABAP Statement
EV_EXCEPTION = "Exception

TABLES
IT_SEARCH_CRITERIA = "Generic Query Structure
* ET_SEARCH_RESULT = "Return Structure for Participants Search
* ET_RETURN = "Message Log: Error, Warning, Information, Success Messages
.



IMPORTING Parameters details for ICLX_QUERY_PARTICIPANT_IN

IV_FILL_FIELD_DESCR -

Data type: BOOLE_D
Default: 'X'
Optional: Yes
Call by Reference: No ( called with pass by value option)

IV_MAX_RECORDS -

Data type: INT4
Default: '50'
Optional: Yes
Call by Reference: No ( called with pass by value option)

IV_LANGUAGE_ISO - Language According to ISO 639

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

EXPORTING Parameters details for ICLX_QUERY_PARTICIPANT_IN

EV_SUBRC - Return Value from ABAP Statement

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

EV_EXCEPTION - Exception

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

TABLES Parameters details for ICLX_QUERY_PARTICIPANT_IN

IT_SEARCH_CRITERIA - Generic Query Structure

Data type: ICLX_QUERY_S_IN
Optional: No
Call by Reference: Yes

ET_SEARCH_RESULT - Return Structure for Participants Search

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

ET_RETURN - Message Log: Error, Warning, Information, Success Messages

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

Copy and paste ABAP code example for ICLX_QUERY_PARTICIPANT_IN 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_ev_subrc  TYPE SYSUBRC, "   
lt_it_search_criteria  TYPE STANDARD TABLE OF ICLX_QUERY_S_IN, "   
lv_iv_fill_field_descr  TYPE BOOLE_D, "   'X'
lv_ev_exception  TYPE ICLX_EXCEPTION_D, "   
lv_iv_max_records  TYPE INT4, "   '50'
lt_et_search_result  TYPE STANDARD TABLE OF ICLX_SR_PARTICIPANT_S_IN, "   
lt_et_return  TYPE STANDARD TABLE OF ICLX_MESSAGE_PROTOCOL_S_IN, "   
lv_iv_language_iso  TYPE LAISO. "   

  CALL FUNCTION 'ICLX_QUERY_PARTICIPANT_IN'  "API 'Search for Participants'
    EXPORTING
         IV_FILL_FIELD_DESCR = lv_iv_fill_field_descr
         IV_MAX_RECORDS = lv_iv_max_records
         IV_LANGUAGE_ISO = lv_iv_language_iso
    IMPORTING
         EV_SUBRC = lv_ev_subrc
         EV_EXCEPTION = lv_ev_exception
    TABLES
         IT_SEARCH_CRITERIA = lt_it_search_criteria
         ET_SEARCH_RESULT = lt_et_search_result
         ET_RETURN = lt_et_return
. " ICLX_QUERY_PARTICIPANT_IN




ABAP code using 7.40 inline data declarations to call FM ICLX_QUERY_PARTICIPANT_IN

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.

 
 
DATA(ld_iv_fill_field_descr) = 'X'.
 
 
DATA(ld_iv_max_records) = '50'.
 
 
 
 


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!