xref: /illumos-gate/usr/src/man/man3ldap/ldap_friendly.3ldap (revision ddb365bfc9e868ad24ccdcb0dc91af18b10df082)
te
Copyright (C) 1990, Regents of the University of Michigan. All Rights Reserved.
Portions Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
LDAP_FRIENDLY 3LDAP "Jan 27, 2002"
NAME
ldap_friendly, ldap_friendly_name, ldap_free_friendlymap - LDAP attribute remapping functions
SYNOPSIS

cc[ flag... ] file... -lldap[ library... ]
#include <lber.h>
#include <ldap.h>

char *ldap_friendly_name(char *filename, char *name,
 FriendlyMap **map);

void ldap_free_friendlymap(FriendlyMap **map);
DESCRIPTION

This function is used to map one set of strings to another. Typically, this is done for country names, to map from the two-letter country codes to longer more readable names. The mechanism is general enough to be used with other things, though.

filename is the name of a file containing the unfriendly to friendly mapping, name is the unfriendly name to map to a friendly name, and map is a result-parameter that should be set to NULL on the first call. It is then used to hold the mapping in core so that the file need not be read on subsequent calls.

For example:

 FriendlyMap *map = NULL;
 printf( "unfriendly %s => friendly %s\en", name,
 ldap_friendly_name( "ETCDIR/ldapfriendly", name, &map ) );

The mapping file should contain lines like this: unfriendlyname\etfriendlyname. Lines that begin with a '#' character are comments and are ignored.

The ldap_free_friendlymap() call is used to free structures allocated by ldap_friendly_name() when no more calls to ldap_friendly_name() are to be made.

ERRORS

NULL is returned by ldap_friendly_name() if there is an error opening filename, or if the file has a bad format, or if the map parameter is NULL.

FILES

ETCDIR/ldapfriendly.conf

ATTRIBUTES

See attributes(7) for a description of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
SEE ALSO

ldap (3LDAP), attributes (7)