ldap_get_paged_count function (winldap.h)
The ldap_get_paged_count function records the number of paged results that the server has returned for a search.
Syntax
WINLDAPAPI ULONG LDAPAPI ldap_get_paged_count(
[in] PLDAP ExternalHandle,
[in] PLDAPSearch SearchBlock,
[out] ULONG *TotalCount,
[out] PLDAPMessage Results
);
Parameters
[in] ExternalHandle
The session handle.
[in] SearchBlock
Handle to an LDAPSearch structure.
[out] TotalCount
The total pages in the search results.
[out] Results
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2008 |
| Target Platform | Windows |
| Header | winldap.h |
| Library | Wldap32.lib |
| DLL | Wldap32.dll |