usr/src/man/man3ldap/ldap_get_entry_controls.3ldap

   1 '\" te
   2 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH LDAP_GET_ENTRY_CONTROLS 3LDAP "Jan 6, 2003"
   8 .SH NAME
   9 ldap_get_entry_controls \- get the LDAP controls included with a directory
  10 entry in a set of search results
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR\fB-flag \&.\|.\|.\fR \fIfile\fR\&.\|.\|.\fB-l\fRldap [\fB -library \&.\|.\|. \fR]
  15 #include <ldap.h>
  16
  17 \fBint\fR \fBldap_get_entry_controls\fR(\fBLDAP *\fR\fIld\fR, \fBLDAPMessage *\fR\fIentry\fR,
  18      \fBLDAPControl ***\fR\fIserverctrlsp\fR
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBldap_get_entry_controls()\fR function retrieves the LDAP v3 controls
  25 included in a directory entry in a chain of search results. The LDAP controls
  26 are specified in an array of \fBLDAPControl\fR structures. Each
  27 \fBLDAPControl\fR structure represents an LDAP control. The function takes
  28 \fIentry\fR as a parameter, which points to an \fBLDAPMessage\fR structure that
  29 represents an entry in a chain of search results.
  30 .sp
  31 .LP
  32 The entry notification controls that are used with persistent search controls
  33 are the only controls that are returned with individual entries. Other controls
  34 are returned with results sent from the server. You can call
  35 \fBldap_parse_result()\fR to retrieve those controls.
  36 .SH ERRORS
  37 .sp
  38 .LP
  39 \fBldap_get_entry_controls()\fR returns the following error codes.
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBLDAP_SUCCESS\fR\fR
  44 .ad
  45 .RS 23n
  46 LDAP controls were successfully retrieved.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBLDAP_DECODING_ERROR\fR\fR
  53 .ad
  54 .RS 23n
  55 An error occurred when decoding the BER-encoded message.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBLDAP_PARAM_ERROR\fR\fR
  62 .ad
  63 .RS 23n
  64 An invalid parameter was passed to the function.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBLDAP_NO_MEMORY\fR\fR
  71 .ad
  72 .RS 23n
  73 Memory cannot be allocated.
  74 .RE
  75
  76 .SH ATTRIBUTES
  77 .sp
  78 .LP
  79 See \fBattributes\fR(5)  for descriptions of the following attributes:
  80 .sp
  81
  82 .sp
  83 .TS
  84 box;
  85 c | c
  86 l | l .
  87 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  88 _
  89 Interface Stability     Evolving
  90 .TE
  91
  92 .SH SEE ALSO
  93 .sp
  94 .LP
  95 \fBldap_error\fR(3LDAP), \fBldap_parse_result\fR(3LDAP), \fBattributes\fR(5)