SAP BAPI_USER_GETLIST Function Module for Search for Users









BAPI_USER_GETLIST is a standard bapi user getlist SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Search for Users 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 bapi user getlist FM, simply by entering the name BAPI_USER_GETLIST into the relevant SAP transaction such as SE37 or SE38.

Function Group: SU_USER
Program Name: SAPLSU_USER
Main Program: SAPLSU_USER
Appliation area:
Release date: 16-Aug-2003
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function BAPI_USER_GETLIST 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 'BAPI_USER_GETLIST'"Search for Users
EXPORTING
* MAX_ROWS = 0 "Maximum Number of Lines of Hits
* WITH_USERNAME = ' ' "Read User with Name

IMPORTING
ROWS = "No. of users selected

TABLES
* SELECTION_RANGE = "Search for Users with a Ranges Table
* SELECTION_EXP = "Search for Users with Free Selections
* USERLIST = "User List
* RETURN = "Return Parameter
.



IMPORTING Parameters details for BAPI_USER_GETLIST

MAX_ROWS - Maximum Number of Lines of Hits

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

WITH_USERNAME - Read User with Name

Data type: BAPIUSMISC-WITH_NAME
Default: SPACE
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for BAPI_USER_GETLIST

ROWS - No. of users selected

Data type: BAPIUSMISC-BAPIROWS
Optional: No
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for BAPI_USER_GETLIST

SELECTION_RANGE - Search for Users with a Ranges Table

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

SELECTION_EXP - Search for Users with Free Selections

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

USERLIST - User List

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

RETURN - Return Parameter

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

Copy and paste ABAP code example for BAPI_USER_GETLIST 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_rows  TYPE BAPIUSMISC-BAPIROWS, "   
lv_max_rows  TYPE BAPIUSMISC-BAPIMAXROW, "   0
lt_selection_range  TYPE STANDARD TABLE OF BAPIUSSRGE, "   
lt_selection_exp  TYPE STANDARD TABLE OF BAPIUSSEXP, "   
lv_with_username  TYPE BAPIUSMISC-WITH_NAME, "   SPACE
lt_userlist  TYPE STANDARD TABLE OF BAPIUSNAME, "   
lt_return  TYPE STANDARD TABLE OF BAPIRET2. "   

  CALL FUNCTION 'BAPI_USER_GETLIST'  "Search for Users
    EXPORTING
         MAX_ROWS = lv_max_rows
         WITH_USERNAME = lv_with_username
    IMPORTING
         ROWS = lv_rows
    TABLES
         SELECTION_RANGE = lt_selection_range
         SELECTION_EXP = lt_selection_exp
         USERLIST = lt_userlist
         RETURN = lt_return
. " BAPI_USER_GETLIST




ABAP code using 7.40 inline data declarations to call FM BAPI_USER_GETLIST

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.

"SELECT single BAPIROWS FROM BAPIUSMISC INTO @DATA(ld_rows).
 
"SELECT single BAPIMAXROW FROM BAPIUSMISC INTO @DATA(ld_max_rows).
 
 
 
"SELECT single WITH_NAME FROM BAPIUSMISC INTO @DATA(ld_with_username).
DATA(ld_with_username) = ' '.
 
 
 


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!