on_search_result Event

Fired for every entry returned from a search operation.

Syntax

class LDAPSearchResultEventParams(object):
  @property
  def message_id() -> int: ...
  @property
  def dn() -> str: ...

# In class LDAP:
@property
def on_search_result() -> Callable[[LDAPSearchResultEventParams], None]: ...
@on_search_result.setter
def on_search_result(event_hook: Callable[[LDAPSearchResultEventParams], None]) -> None: ...

Remarks

MessageId identifies the corresponding search request. DN contains the Distinguished Name of the entry, while the attribute type and value provided in the attributes properties, show the list of retrieved attributes for the entry.

Every search operation results in a sequence of 0 or more on_search_result events, a sequence of 0 or more on_search_result_reference events, followed by a on_search_complete event.