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

   1 '\" te
   2 .\" Copyright (C) 1990, Regents of the University of Michigan.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2002, 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_FRIENDLY 3LDAP "Jan 27, 2002"
   8 .SH NAME
   9 ldap_friendly, ldap_friendly_name, ldap_free_friendlymap \- LDAP attribute
  10 remapping functions
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc[ \fIflag\fR... ] \fIfile\fR... -lldap[ \fIlibrary\fR... ]
  15 #include <lber.h>
  16 #include <ldap.h>
  17
  18 \fBchar *\fR\fBldap_friendly_name\fR(\fBchar\fR \fI*filename\fR, \fBchar\fR \fI*name\fR,
  19      \fBFriendlyMap\fR \fI**map\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBvoid\fR \fBldap_free_friendlymap\fR(\fBFriendlyMap\fR \fI**map\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 This function is used to map one set of strings to another.  Typically, this is
  31 done for country names, to map from the two-letter country codes to longer more
  32 readable names.  The mechanism is general enough to be used with other things,
  33 though.
  34 .sp
  35 .LP
  36 \fIfilename\fR is the name of a file containing the unfriendly to friendly
  37 mapping, \fIname\fR is the unfriendly name to map to a friendly name, and
  38 \fImap\fR is a result-parameter that should be set to NULL on the first call.
  39 It is then used to hold the mapping in core so that the file need not be read
  40 on subsequent calls.
  41 .sp
  42 .LP
  43 For example:
  44 .sp
  45 .in +2
  46 .nf
  47         FriendlyMap *map = NULL;
  48         printf( "unfriendly %s => friendly %s\en", name,
  49             ldap_friendly_name( "ETCDIR/ldapfriendly", name, &map ) );
  50 .fi
  51 .in -2
  52
  53 .sp
  54 .LP
  55 The mapping file should contain lines like this: unfriendlyname\etfriendlyname.
  56 Lines that begin with a '#' character are comments and are ignored.
  57 .sp
  58 .LP
  59 The \fBldap_free_friendlymap()\fR call is used to free structures allocated by
  60 \fBldap_friendly_name()\fR when no more calls to \fBldap_friendly_name()\fR are
  61 to be made.
  62 .SH ERRORS
  63 .sp
  64 .LP
  65 \fINULL\fR is returned by \fBldap_friendly_name()\fR if there is an error
  66 opening \fIfilename\fR, or if the file has a bad format, or if the \fImap\fR
  67 parameter is \fINULL\fR.
  68 .SH FILES
  69 .sp
  70 .LP
  71 \fBETCDIR/ldapfriendly.conf\fR
  72 .SH ATTRIBUTES
  73 .sp
  74 .LP
  75 See \fBattributes\fR(5) for a description of the following attributes:
  76 .sp
  77
  78 .sp
  79 .TS
  80 box;
  81 c | c
  82 l | l .
  83 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  84 Interface Stability     Evolving
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBldap\fR(3LDAP), \fBattributes\fR(5)