Export (0) Print
Expand All
Expand Minimize

ldap_get_paged_count function

The ldap_get_paged_count function records the number of paged results that the server has returned for a search.

Syntax


ULONG ldap_get_paged_count(
  _In_   PLDAP ExternalHandle,
  _In_   PLDAPSearch SearchBlock,
  _Out_  ULONG *TotalCount,
  _Out_  PLDAPMessage Results
);

Parameters

ExternalHandle [in]

The session handle.

SearchBlock [in]

Handle to an LDAPSearch structure.

TotalCount [out]

The total pages in the search results.

Results [out]

A pointer to the LDAPMessage structure that contains the results of the operation.

Return value

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. For more information, see Return Values.

Remarks

Call ldap_get_paged_count for each result set received after calling ldap_get_next_page. This allows the LDAP runtime to save from the cookie that the server uses to track the search.

If you call ldap_get_next_page_s, a call to ldap_get_paged_count is not required.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Header

Winldap.h

Library

Wldap32.lib

DLL

Wldap32.dll

See also

Functions
ldap_get_next_page
ldap_get_next_page_s
LDAPMessage
LDAPSearch
Return Values

 

 

Show:
© 2014 Microsoft