usr/src/man/man3ldap/ldap_version.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_VERSION 3LDAP "Oct 19, 2001"
   8 .SH NAME
   9 ldap_version \- get version information about the LDAP SDK for C
  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 \fBint\fR \fBldap_version\fR(\fBLDAPVERSION\fR *\fIver\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 A call to this function returns the version information for the LDAP SDK for C.
  23 This is a deprecated function. Use \fBldap_get_option\fR(3LDAP) instead. The
  24 version information is returned in the \fBLDAPVersion\fR  structure pointed to
  25 by \fIver\fR. If \fINULL\fR is passed for \fIver\fR, then only the  SDK version
  26 will be returned.
  27 .SH RETURN VALUES
  28 .sp
  29 .LP
  30 The \fBldap_version()\fR function returns the version number of the LDAP SDK
  31 for C, multiplied by 100. For example, for version 1.0 of the LDAP SDK for C,
  32 the function returns \fB100\fR.
  33 .SH ATTRIBUTES
  34 .sp
  35 .LP
  36 See \fBattributes\fR(5) for descriptions of the following attributes:
  37 .sp
  38
  39 .sp
  40 .TS
  41 box;
  42 c | c
  43 l | l .
  44 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  45 _
  46 Interface Stability     Obsolete
  47 .TE
  48
  49 .SH SEE ALSO
  50 .sp
  51 .LP
  52 \fBldap_get_option\fR(3LDAP), \fBattributes\fR(5)