Expand Minimize

ldap_parse_page_control function

The ldap_parse_page_control parses the results of a search into pages.

Syntax


ULONG ldap_parse_page_control(
  _In_   PLDAP ExternalHandle,
  _In_   PLDAPControl *ServerControls,
  _Out_  ULONG *TotalCount,
  _Out_  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 [out]

A pointer to the total count of entries returned in this page (optional).

Cookie [out]

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

Return value

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winldap.h

Library

Wldap32.lib

DLL

Wldap32.dll

Unicode and ANSI names

ldap_parse_page_controlW (Unicode) and ldap_parse_page_controlA (ANSI)

See also

Functions
ldap_create_page_control
ldap_parse_result

 

 

Show:
© 2014 Microsoft. All rights reserved.