LDAP_READ SAP Function module

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

Associated Function Group: FSLDAP_EXT
Released Date: Not Released
Processing type: Normal fucntion module

Pattern for FM LDAP_READ - LDAP READ

CALL FUNCTION 'LDAP_READ' "
* EXPORTING
*   base = ''                   " ldapdefs-base
*   base_string =               " ldap_dns      Distinguished Name (String)
*   scope = 2                   " ldapdefs-scop
*   filter = '(objectclass=*)'  " ldapdefs-filt
*   filter_string =             " ldap_filts    Search Filter (String)
*   timeout =                   " ldap_time
*   attributes =                " ldapastab     Table with Attribute Names and Types
  IMPORTING
    ldaprc =                    " ldapdefs-ldrc
    entries =                   " ldapetab
  EXCEPTIONS
    NO_AUTHORIZ = 1             "               No Authorization
    CONN_OUTDATE = 2            "               Old connection
    LDAP_FAILURE = 3            "
    NOT_ALIVE = 4               "
    OTHER_ERROR = 5             "
    .  "  LDAP_READ

ABAP code example for Function Module LDAP_READ

The ABAP code below is a full code listing to execute function module LDAP_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_ldaprc  
 
 TYPE LDAPDEFS-LDRC
,
ld_entries  
 
 TYPE LDAPETAB
.



DATA(ld_base) = some text here

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


DATA(ld_scope) = 123 


DATA(ld_filter) = some text here

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

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

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

CALL FUNCTION 'LDAP_READ'
* EXPORTING
*   base =                       ld_base
*   base_string =                ld_base_string
*   scope =                      ld_scope
*   filter =                     ld_filter
*   filter_string =              ld_filter_string
*   timeout =                    ld_timeout
*   attributes =                 ld_attributes
  IMPORTING
    ldaprc =                     ld_ldaprc
    entries =                    ld_entries
  EXCEPTIONS
    NO_AUTHORIZ =                1
    CONN_OUTDATE =               2
    LDAP_FAILURE =               3
    NOT_ALIVE =                  4
    OTHER_ERROR =                5
    .  "  LDAP_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
ELSEIF SY-SUBRC EQ 3. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 4. "Exception
  "Add code for exception here
ELSEIF SY-SUBRC EQ 5. "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_ldaprc
 
 TYPE LDAPDEFS-LDRC ,
ld_base
 
 TYPE LDAPDEFS-BASE ,
ld_entries
 
 TYPE LDAPETAB ,
ld_base_string
 
 TYPE LDAP_DNS ,
ld_scope
 
 TYPE LDAPDEFS-SCOP ,
ld_filter
 
 TYPE LDAPDEFS-FILT ,
ld_filter_string
 
 TYPE LDAP_FILTS ,
ld_timeout
 
 TYPE LDAP_TIME ,
ld_attributes
 
 TYPE LDAPASTAB .



ld_base = some text here
ld_base_string = 'Check type of data required'.

ld_scope = 123 

ld_filter = some text here
ld_filter_string = 'Check type of data required'.
ld_timeout = 'Check type of data required'.
ld_attributes = 'Check type of data required'.