ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Communication / LDAP functions
  • LDAP filter
  • Examples of filters
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
LDAPFind (Function)
In french: LDAPRecherche
Performs a search in an LDAP server. The search is performed recursively. You also have the ability to use LDAPListChildren.
Example
// All the names starting with s and w
sCriterion1 is string = "(|(displayname=s*)(displayname=w*))"
 
// All the names that sound like kurd
sCriterion2 is string = "(displayname~=kurd)"
 
// All the names with a givenname except Mark
sCriterion3 is string = "(&(givenname=*)(!givenname=Mark))"
 
sSearchResult = LDAPFind("MySession", WIN_FirstWin.EDT_DNBASE, sCriterion1)
gsListSearch += sSearchResult + CR
 
sSearchResult = LDAPFind("MySession", WIN_FirstWin.EDT_DNBASE, sCriterion2)
gsListSearch += sSearchResult + CR
 
sSearchResult = LDAPFind("MySession", WIN_FirstWin.EDT_DNBASE, sCriterion3)
gsListSearch += sSearchResult + CR
Syntax
<Result> = LDAPFind(<LDAP session> , <DN of base object> , <Search criterion>)
<Result>: Character string
  • List of distinguished names (DN) for the objects found. The different elements are separated by "CR" characters (Carriage Return).
  • Empty string ("") if no object corresponding to the search was found.
    If an error occurs, <Result> corresponds to an empty string ("") and the ErrorOccurred variable is set to True. ErrorInfo returns more details about the error.
<LDAP session>: Character string
Name of LDAP session used.
<DN of base object>: Character string
Distinguished Name (DN) of object from which the search is performed.
<Search criterion>: Character string
LDAP filter that will be applied to the search. For more details, see remarks.
Remarks

LDAP filter

The search filter uses the syntax of LDAP search filters. These filters can use one of the following syntaxes:
  • (<Attribute><Operator><Value>)
  • (<Operator><Filter1><Filter2>)
In these syntaxes:
  • <Attribute> corresponds to the name of an LDAP attribute.
  • <Operator> can take one of the following values:
    • =: Equality
    • ~=: Approximation
    • <=: Less than or equal to
    • >=: Greater than or equal to
    • &: AND
    • |: OR
    • !: NO
  • <Value> corresponds to the sought value. The "*" character is allowed.
    If special characters must be used in the search filter, these characters must be replaced with the corresponding sequence:
    • Character *: \2a
    • Character (: \28
    • Character ): \29
    • Character \: \5c
    • Character NULL: \00
    • Character /: \2f
  • <Filter1> is a filter in the following format: (<Attribute><Operator><Value>)
  • <Filter2> is a filter in the following format: (<Attribute><Operator><Value>)

Examples of filters

"(objectClass=*)"Filters all the objects
"(&(objectCategory=person)(objectClass=user)(!cn=andy))"Filters all the users except "andy"
"(sn=sm*)"Filters the objects whose 'sn' starts with 'sm'
"(&(objectCategory=person)(objectClass=contact)(|(sn=Smith)(sn=Johnson)))"Filters all the contacts whose 'sn' is 'Smith' or 'Johnson'
Component: wd290com.dll
See also
Minimum version required
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/26/2022

Send a report | Local help