on_search_page Event

Fired for every page returned from a search operation.

Syntax

class LDAPSearchPageEventParams(object):
  @property
  def message_id() -> int: ...
  @property
  def dn() -> str: ...
  @property
  def result_code() -> int: ...
  @property
  def result_description() -> str: ...
  @property
  def cancel_search() -> bool: ...
  @cancel_search.setter
  def cancel_search(value) -> None: ...

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

Remarks

This event is where the client can decide whether to continue with the search operation or not. The signature is very similar to the on_search_complete event, with the addition of a CancelSearch parameter. If the search should be canceled (no more pages), the CancelSearch parameter should be set to true.