Table of Contents | Previous | Next | Index

Netscape Directory SDK 3.0 for C Programmer’s Guide
     Chapter 18 Functions

ldap_parse_virtuallist_control()

Parses the result returned from a search operation that used a server control for virtual list views.

This function implements an extension to the LDAP v3 protocol. A virtual list view is an optional LDAP server feature; it may not be supported on all LDAP servers. Call this function when interacting with LDAP servers that support this LDAP v3 extension.

Syntax 

#include <ldap.h> 
int ldap_parse_virtuallist_control( LDAP *ld, 
   LDAPControl **ctrls, unsigned long *target_posp, 
   unsigned long *list_sizep, int *errcodep );

Parameters

This function has the following parameters: 

ld

Connection handle, which is a pointer to an LDAP structure containing information about the connection to the LDAP server. 

ctrls

An array of controls returned by the server. You obtain these controls by calling the ldap_parse_result() function on the set of results returned by the server. 

target_posp

Pointer to an unsigned long that is set by the function. The function sets this to the index or offset of the selected entry in the list of entries. 

list_sizep

Pointer to an unsigned long that is set by the function. The function sets this to the number of entries in the total number of entries in the entire list (not just the subset). 

errcodep

Pointer to the sort control result code retrieved by this function.

Returns

One of the following values:

Description

Call the ldap_parse_virtuallist_control() function as part of the process of retrieving a subset of entries from a list when working with a virtual list view box.

Call this function after receiving the results (call ldap_result() to get the results) and parsing the server controls from the results (call ldap_parse_result() to get the controls from the results).

At this point in time, no server supports this control. (The Netscape Directory Server 3.x does not support this control, although future releases of the Directory Server plan to support it.) For information on determining if a server supports this or other LDAP v3 controls, see "Determining If the Server Supports LDAP v3" on page 264.

For more information about this control, see "Using the Virtual List View Control" on page 304.

See Also

ldap_create_virtuallist_control().

Table of Contents | Previous | Next | Index

Last Updated: 10/01/98 17:06:23