DDAP gate, SEARCH_LDAP function
The SEARCH_LDAP function of the DDAP gate sends a search request to a specified LDAP server.
Input Parameters
- DISTINGUISHED_NAME
- specifies the location of the LDAP distinguished name. The block-descriptor is two fullwords of data, in which the first word contains the address of the data, and the second word contains the length in bytes of the data. For more information on block-descriptors, see XPI syntax.
- FILTER
- Optional parameter
- specifies the location of an LDAP filter string that limits the search. If this parameter is not specified or is zero, the search filter is set to (objectClass=*). The block-descriptor is two fullwords of data, in which the first word contains the address of the data, and the second word contains the length in bytes of the data. For more information on block-descriptors, see XPI syntax.
- LDAP_SESSION_TOKEN
- the name of the fullword token that was returned by the BIND_LDAP function.
- SEARCH_TIME_LIMIT
- Optional parameter
- specifies the time limit for the search (in seconds). If the search is not successful within this time limit, the search is abandoned. If this parameter is not specified or is zero, the search time is unlimited.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- INVALID_TOKEN
- NOTFOUND
- TIMED_OUT
- LDAP_INACTIVE
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- ENTRY_COUNT
- Optional parameter
- the number of LDAP entries returned by the search.
- LDAP_RESPONSE
- Optional parameter
- specifies the return code that is sent by the LDAP API.
- SEARCH_TOKEN
- the name of the fullword token that identifies and holds the current position in the search.