diff --git a/reference/ldap/functions/ldap-control-paged-result-response.xml b/reference/ldap/functions/ldap-control-paged-result-response.xml index a743af3ff5..0ca60b2691 100644 --- a/reference/ldap/functions/ldap-control-paged-result-response.xml +++ b/reference/ldap/functions/ldap-control-paged-result-response.xml @@ -1,9 +1,11 @@ - + ldap_control_paged_result_response - Extract paged results control response + Retrieve the LDAP pagination cookie @@ -15,9 +17,67 @@ stringcookie intestimated - &warn.undocumented.func; + + Retrieve the pagination information send by the server. + + + &reftitle.parameters; + + + + link + + + An LDAP link identifier, returned by ldap_connect. + + + + + result + + + + + + + cookie + + + An opaque structure sent by the server. + + + + + estimated + + + The estimated number of entries to retrieve. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + ldap_control_paged_result + RFC2696 : LDAP Control Extension for Simple + Paged Results Manipulation + + + - + ldap_control_paged_result - Inject paged results control + Send LDAP pagination control &reftitle.description; - mixedldap_control_paged_result + boolldap_control_paged_result resourcelink intpagesize - booliscritical - stringcookie + booliscritical + stringcookie - &warn.undocumented.func; + + Enable LDAP pagination by sending the pagination control (page size, cookie...). + + + &reftitle.parameters; + + + + link + + + An LDAP link identifier, returned by ldap_connect. + + + + + pagesize + + + The number of entries by page. + + + + + iscritical + + + Indicates whether the pagination is critical of not. + If true and if the server doesn't support pagination, the search + will return no result. + + + + + cookie + + + An opaque structure sent by the server + (ldap_control_paged_result_response). + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; + + The example below show the retrieval of the first page of a search paginated + with one entry by page. + + LDAP pagination + + + + + + + The example below show the retrieval of all the result paginated with 100 + entries by page. + + LDAP pagination + + + + + + + + + &reftitle.seealso; + + + ldap_control_paged_result_response + RFC2696 : LDAP Control Extension for Simple + Paged Results Manipulation + + +