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

   1 '\" te
   2 .\" Copyright 2015 Nexenta Systems, Inc.  All rights reserved.
   3 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   4 .\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved.
   5 .\" 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.
   6 .\" 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.
   7 .\" 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]
   8 .TH LDAP_MEMFREE 3LDAP "Feb 18, 2015"
   9 .SH NAME
  10 ldap_memfree \- free memory allocated by LDAP API functions
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc \fR\fB-flag \&.\|.\|.\fR  \fIfile \fR\&.\|.\|.\fB-l\fRldap [\fB -library \&.\|.\|. \fR]
  15 #include <lber.h>
  16 #include <ldap.h>
  17
  18 \fBvoid\fR \fBldap_memfree\fR(\fBvoid *\fR\fIp\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .LP
  23 The \fBldap_memfree()\fR function frees the memory allocated by certain LDAP
  24 API functions that do not have corresponding functions to free memory. These
  25 functions include \fBldap_get_dn\fR(3LDAP), \fBldap_first_attribute\fR(3LDAP),
  26 and \fBldap_next_attribute\fR(3LDAP).
  27 .sp
  28 .LP
  29 The \fBldap_memfree()\fR function takes one parameter, \fIp\fR, which is a
  30 pointer to the memory to be freed.
  31 .SH PARAMETERS
  32 .ne 2
  33 .na
  34 \fB\fIp\fR\fR
  35 .ad
  36 .RS 5n
  37 A pointer to the memory to be freed.
  38 .RE
  39
  40 .SH RETURN VALUES
  41 .LP
  42 There are no return values for the \fBldap_memfree()\fR function.
  43 .SH ERRORS
  44 .LP
  45 No errors are defined for the \fBldap_memfree()\fR function.
  46 .SH ATTRIBUTES
  47 .LP
  48 See \fBattributes\fR(5) for descriptions of the following attributes:
  49 .sp
  50
  51 .sp
  52 .TS
  53 box;
  54 c | c
  55 l | l .
  56 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  57 _
  58 Interface Stability     Evolving
  59 .TE
  60
  61 .SH SEE ALSO
  62 .LP
  63 \fBldap\fR(3LDAP), \fBldap_first_attribute\fR(3LDAP), \fBldap_get_dn\fR(3LDAP),
  64 \fBldap_next_attribute\fR(3LDAP), \fBattributes\fR(5)