Table of Contents | Previous | Next | Index

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

ldap_get_entry_controls()

Gets the LDAP controls included with a directory entry in a set of search results.

Syntax

#include <ldap.h>
int ldap_get_entry_controls( LDAP *ld, LDAPMessage *entry, 
   LDAPControl ***serverctrlsp );

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.

entry
Pointer to an LDAPMessage structure representing an entry in a chain of search results.

serverctrlsp
Pointer to an array of LDAPControl structures, which represent the LDAP v3 server controls returned by the server.

Returns

One of the following values:

LDAP_SUCCESS if the LDAP controls were successfully retrieved.

LDAP_DECODING_ERROR if an error occurred when decoding the BER-encoded message.

LDAP_PARAM_ERROR if an invalid parameter was passed to the function

LDAP_NO_MEMORY if memory cannot be allocated.

Description

The ldap_get_entry_controls() function retrieves the LDAP v3 controls included in a directory entry in a chain of search results.

The LDAP controls are specified in an array of LDAPControl structures. (Each LDAPControl structure represents an LDAP control.)

At this point in time, the entry notification controls (which are used with persistent search controls) are the only controls that are returned with individual entries. Other controls are returned with results sent from the server. You can call ldap_parse_result() to retrieve those controls.

Table of Contents | Previous | Next | Index

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