Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 3.5 KB

nf-winldap-ldap_parse_page_control.md

File metadata and controls

98 lines (72 loc) · 3.5 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winldap.ldap_parse_page_control
ldap_parse_page_control function (winldap.h)
The ldap_parse_page_control function (winldap.h) parses the results of a search into pages.
_ldap_ldap_parse_page_control
ldap.ldap__parse__page__control
ldap.ldap_parse_page_control
ldap_parse_page_control
ldap_parse_page_control function [LDAP]
ldap_parse_page_controlA
ldap_parse_page_controlW
winldap/ldap_parse_page_control
winldap/ldap_parse_page_controlA
winldap/ldap_parse_page_controlW
ldap\ldap_parse_page_control.htm
ldap
babf74d1-2f9c-40f8-ba82-e298e49ad937
08/04/2022
_ldap_ldap_parse_page_control, ldap.ldap__parse__page__control, ldap.ldap_parse_page_control, ldap_parse_page_control, ldap_parse_page_control function [LDAP], ldap_parse_page_controlA, ldap_parse_page_controlW, winldap/ldap_parse_page_control, winldap/ldap_parse_page_controlA, winldap/ldap_parse_page_controlW
winldap.h
Windows
Windows Vista
Windows Server 2008
ldap_parse_page_controlW (Unicode) and ldap_parse_page_controlA (ANSI)
Wldap32.lib
Wldap32.dll
Windows
19H1
ldap_parse_page_control
winldap/ldap_parse_page_control
c++
APIRef
kbSyntax
DllExport
Wldap32.dll
ldap_parse_page_control
ldap_parse_page_controlA
ldap_parse_page_controlW

ldap_parse_page_control function

-description

The ldap_parse_page_control parses the results of a search into pages.

-parameters

-param ExternalHandle [in]

The session handle.

-param 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.

-param TotalCount [out]

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

-param Cookie [out]

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

-returns

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.

-see-also

Functions

ldap_create_page_control

ldap_parse_result