share/man/man3ldap/ldap_ber_free.3ldap

   1 '\" te
   2 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2001, 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_BER_FREE 3LDAP "Oct 25, 2001"
   8 .SH NAME
   9 ldap_ber_free \- free a BerElement structure from memory
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc \fR\fB-flag \&.\|.\|.\fR  \fIfile \fR\&.\|.\|.\fB-l\fRldap [\fB -library \&.\|.\|. \fR]
  14 #include <ldap.h>
  15
  16 \fBvoid\fR \fBldap_ber_free\fR(\fBBerElement *\fR\fIber\fR, \fBint\fR \fIfreebuf\fR
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 You can make a call to the \fBldap_ber_free()\fR function to free
  23 \fBBerElement\fR structures allocated by \fBldap_first_attribute()\fR and by
  24 \fBldap_next_attribute()\fR function calls. When freeing structures allocated
  25 by these functions, specify 0 for the \fIfreebuf\fR argument. The
  26 \fBldap_first_attribute()\fR and by \fBldap_next_attribute()\fR functions do
  27 not allocate the extra buffer in the \fBBerElement\fR structure.
  28 .sp
  29 .LP
  30 For example, to retrieve attributes from a search result entry, you need to
  31 call the \fBldap_first_attribute()\fR function. A call to this function
  32 allocates a \fBBerElement\fR structure, which is used to help track the current
  33 attribute. When you are done working with the attributes, this structure should
  34 be freed from memory, if it still exists.
  35 .sp
  36 .LP
  37 This function is deprecated . Use the \fBber_free()\fR function instead.
  38 .SH ATTRIBUTES
  39 .sp
  40 .LP
  41 See \fBattributes\fR(5)  for descriptions of the following attributes:
  42 .sp
  43
  44 .sp
  45 .TS
  46 box;
  47 c | c
  48 l | l .
  49 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  50 _
  51 Interface Stability     Obsolete
  52 .TE
  53
  54 .SH SEE ALSO
  55 .sp
  56 .LP
  57 \fBber_free\fR(3LDAP), \fBldap_first_attribute\fR(3LDAP),
  58 \fBldap_next_attribute\fR(3LDAP), \fBattributes\fR(5)