Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function parses the results of a search into pages.

Syntax 

ULONG ldap_parse_page_control(
  LDAP* 
ExternalHandle,
  LDAPControl** 
ServerControls,
  ULONG* 
TotalCount,
  struct berval** 
Cookie
);

Parameters

ExternalHandle

[in] Session handle.

ServerControls

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

TotalCount

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

Cookie

[out] Opaque cookie used by the server to determine its location in the result set.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

If this function fails, it returns an error code. See the LDAP_RETCODEenumeration for a list of possible return values.

Remarks

Use this function in conjunction with ldap_create_page_controland ldap_parse_resultto implement the simple paging of results by means of controls. After calling ldap_parse_page_controlto retrieve the server controls and extract the cookie from the search result, call ldap_parse_resultto parse the results. Then use the cookie to call ldap_create_page_controlto retrieve the next page of results.

Requirements

Header winldap.h
Library wldap32.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also