pagedResults

Name: pagedResults
Description: Used on a SearchRequest and SearchResultDone message to control the rate at which the server returns search results.
Assigned object identifier: 1.2.840.113556.1.4.319
Target of control: Server
Control criticality: Critical at client's option
Request values: The following ASN.1 (Abstract Syntax Notation One) syntax describes the BER (Basic Encoding Rules) encoding of the request control values:
```
RequestControlValue ::= SEQUENCE {
   size         INTEGER,
   cookie       OCTET STRING
}
```
where,
- size - Specifies the requested page size, the number of entries to return. A page size of zero ends the sequence of paged search requests.
- cookie - Specifies an empty string to obtain the initial page of search results, or specifies the cookie that was returned in the previous paged search response to obtain the next page of search results.
Response values: The following ASN.1 (Abstract Syntax Notation One) syntax describes the BER (Basic Encoding Rules) encoding of the response control values:
```
ResponseControlValue ::= SEQUENCE {
   size         INTEGER,
   cookie       OCTET STRING
}
```
where,
- size - Specifies the estimated number of entries in the entire result set.
- cookie - Specifies the cookie that is required to retrieve the next page of search results, or specifies an empty string if there are no more entries to return.
Detailed description: Paged search results provide paging capabilities for LDAP client applications that want to receive just a subset of search results instead of the entire result set. The next page of entries is returned to the client application for each subsequent paged search request submitted by the client until the operation is canceled or the last page of results is returned.
This control is valid when sent on a client's SearchRequest message and when sent back to the client on a SearchResultDone message. Support is provided in the z/OS® LDAP client to create and parse the control. See the ldap_create_page_control() and ldap_parse_page_control() APIs and the ldapsearch client utility in z/OS IBM Tivoli Directory Server Client Programming for z/OS for more information.

See RFC 2696 for more information about the paged search results control.
Server behavior: By default, the ibm-slapdPagedResLmt dynamic configuration attribute in the cn=configuration entry is set to 0 which indicates that paged searches are not allowed. Therefore, the ibm-slapdPagedResLmt attribute must be set to a nonzero value to allow paged searches. The ibm-slapdPagedResAllowNonAdmin and ibm-slapdPagedResLmt dynamic configuration attributes in the cn=configuration entry and the idleConnectionTimeout configuration option can be used to limit server resources used by paged searches. The PersistentSearch and pagedResults server controls cannot both be specified on a search request. See cn=configuration for more information about the dynamic configuration attributes in the cn=configuration entry. The server ignores the paged search request control if the page is greater than or equal to the size limit value specified in the search request. A paged search response control is not returned by the server in this case.