ldap_get_paged_count

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

ULONG ldap_get_paged_count(
  LDAP* ExternalHandle,
  LDAPSearch* SearchBlock,
  ULONG* TotalCount,
  LDAPMessage* Results
);

Parameters

• ExternalHandle
  [in] Session handle.

• SearchBlock
  [in] Handle to an LDAPSearch structure.

• TotalCount
  [out] Total number of pages in the search results.

• Results
  [out] Pointer to the LDAPMessage structure that contains the results of the operation.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

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

Remarks

You must call this function for each set of results that you get after calling the ldap_get_next_page function. This allows the LDAP run time to save from the cookie that the server uses to keep track of the search.

If you call ldap_get_next_page_s, you do not need to call this function.

Requirements

See Also

Reference

LDAP_RETCODE
ldap_get_next_page
ldap_get_next_page_s
LDAPMessage
LDAPSearch