ldap_parse_reference_control

Decodes the information returned from a search operation that used a server-side sort control.

LDAP Version:v3

Library:*ldapsdk.*

NDS Version:8.xx or higher

Platform:NLM, Windows (NT, 95, 98, 2000, XP, Vista 32-bit and 64-bit ), Linux (32-bit and 64-bit), Solaris, AIX, and HP-UX

Syntax

  #include <ldap.h>ldap_parse_reference_control (
          LDAP             *ld,
          LDAPControl    **ctrls,
          char             *locRef,
          int              refType,
          char             *remainingName,
          int              scope,
          char             **searchedSubtrees,
          char             *failedName)

Parameters

ld: (IN) Points to the handle of the LDAP session.
ctrls: (IN) Points to the address of a null-terminated array of LDAPControl structures obtained by a call to the ldap_parse_result function.
locRef: (OUT) Names the DSE found to hold distributed knowledge information.
refType: (OUT) Indicates the DSE type of ContinuationReference.
remainingName: (OUT) Indicates the new target object if localReference do not completely name the DSE.
searchScope: (OUT) Indicates the search scope of the search operation.
searchedSubtrees: (OUT) Indicates that the search operation has already searched the subtree.
failedName: (OUT) Specifies the non-local names.

Return Values

0x00	LDAP_SUCCESS
Non-zero	Failure. See LDAP Return Codes.