page_size Property

The maximum number of results per page for the Search method.

Syntax

def get_page_size() -> int: ...
def set_page_size(value: int) -> None: ...

page_size = property(get_page_size, set_page_size)

Default Value

0

Remarks

This property contains the maximum number of results per page for the search method. The default value is 0 (no paging). If set to a value greater than zero, results will be paged, i.e. returned in blocks of maximum page_size results.

For each page sent by the server, a on_search_page event will fire. you may decide to cancel or continue displaying results from within this event.

Note: LDAP paging functionality is described by LDAP extension RFCs and may or may not be implemented by the LDAP server being accessed.