ldap_parse_page_control

The ldap_parse_page_control parses the results of a search into pages.

ULONG ldap_parse_page_control(
  PLDAP ExternalHandle,
  PLDAPControl* ServerControls,
  ULONG* TotalCount,
  struct berval** Cookie
);

Parameters

ExternalHandle

[in] The session handle.

ServerControls

[in] An array of controls that includes a page control. The page control contains the cookie and total count fields returned by the server.

TotalCount

[in] A pointer to the total count of entries returned in this page.

Cookie

[out] An opaque cookie, used by the server to determine its location in the result set. Use ber_bvfree to free.

Return Values

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. See Return Values for more information.

Remarks

Use ldap_parse_page_control in conjunction with ldap_create_page_control and ldap_parse_result to implement the simple paging of results by means of controls. After calling ldap_parse_page_control to retrieve the server controls and extract the cookie from the search result, call ldap_parse_result to parse the results. Then use the cookie to call ldap_create_page_control to retrieve the next page of results.

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Unicode: Implemented as Unicode and ANSI versions on all platforms.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Functions, ldap_create_page_control, ldap_parse_result