man/man3ldap/ldap_get_entry_controls.3ldap

         te
 Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved.
 Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved.
 The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
 When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 LDAP_GET_ENTRY_CONTROLS 3LDAP "Jan 6, 2003"
 NAME
ldap_get_entry_controls - get the LDAP controls included with a directory
entry in a set of search results
 SYNOPSIS

cc-flag .\|.\|. file.\|.\|.-lldap [ -library .\|.\|. ]
#include <ldap.h>

int ldap_get_entry_controls(LDAP *ld, LDAPMessage *entry,
 LDAPControl ***serverctrlsp


 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. The function takes
entry as a parameter, which points to an LDAPMessage structure that
represents an entry in a chain of search results.

The entry notification controls that 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.
 ERRORS

ldap_get_entry_controls() returns the following error codes.
LDAP_SUCCESS

LDAP controls were successfully retrieved.


LDAP_DECODING_ERROR

An error occurred when decoding the BER-encoded message.


LDAP_PARAM_ERROR

An invalid parameter was passed to the function.


LDAP_NO_MEMORY

Memory cannot be allocated.


 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:


ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving


 SEE ALSO

ldap_error(3LDAP), ldap_parse_result(3LDAP), attributes(5)