ldap_create_vlv_control

Creates and encodes a server-side virtual list view control to use with a search operation.

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>
  
  int ldap_create_vlv_control (
     LDAP           *ld,
     LDAPVLVInfo    *vlvinfop,
     LDAPControl   **ctrlp);
  
  

Parameters

ld

(IN) Points to the handle of the LDAP session.

vlvinfop

(IN) Points to an LDAPVLVInfo structure that contains the information required to create a virtual list view control.

ctrlp

(OUT) Points to the address of the LDAPControl structure that contains the virtual list view control created by this function. When this control is no longer in use, the memory should be freed by calling the ldap_control_free function.

Return Values

0x00

LDAP_SUCCESS

Non-zero

Failure. See LDAP Return Codes.

Remarks

The virtual list view control must be used with the server-side sort control. The virtual list view control has been assigned the following OID:

For example code, see vlvcntl.c.

See Also

ldap_parse_vlv_control, ldap_search_ext, ldap_search_ext_s, ldap_create_sort_control, ldap_control_free, ldap_controls_free

LDAPVLVInfo, LDAPControl