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_searchprefs, ldap_init_searchprefs, ldap_init_searchprefs_buf, ldap_free_searchprefs, ldap_first_searchobj, ldap_next_searchobj - LDAP search preference configuration routeines

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

int ldap_init_searchprefs(char **file,
 struct ldap_searchobj ***solistp);

int ldap_init_searchprefs_buf(char **buf, unsigned longlen,
 struct ldap_searchobj **solistp);

struct ldap_searchobj **ldap_free_searchprefs
 (struct ldap_searchobj **solist);

struct ldap_searchobj **ldap_first_searchobj
 (struct ldap_seachobj **solist);

struct ldap_searchobj **ldap_next_searchobj
 (struct ldap_seachobj **solist, struct ldap_seachobj **so);

These functions provide a standard way to access LDAP search preference configuration data. LDAP search preference configurations are typically used by LDAP client programs to specify which attributes a user may search by, labels for the attributes, and LDAP filters and scopes associated with those searches. Client software presents these choices to a user, who can then specify the type of search to be performed.

ldap_init_searchprefs() reads a sequence of search preference configurations from a valid LDAP searchpref configuration file. See ldapsearchprefs.conf(5). Upon success, 0 is returned and solistp is set to point to a list of search preference data structures.

ldap_init_searchprefs_buf() reads a sequence of search preference configurations from buf, whose size is buflen. buf should point to the data in the format defined for an LDAP search preference configuration file. See ldapsearchprefs.conf(5). Upon success, 0 is returned and solistp is set to point to a list of search preference data structures.

ldap_free_searchprefs() disposes of the data structures allocated by ldap_init_searchprefs().

ldap_first_searchpref() returns the first search preference data structure in the list solist. The solist is typically obtained by calling ldap_init_searchprefs().

ldap_next_searchpref() returns the search preference after so in the template list solist. A NULL pointer is returned if so is the last entry in the list.

ldap_init_search_prefs() and ldap_init_search_prefs_bufs() return: LDAP_SEARCHPREF_ERR_VERSION

LDAP_SEARCHPREF_ERR_MEM

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

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Evolving

ldap (3LDAP), ldapsearchprefs.conf (5), attributes (7)

Yeong, W., Howes, T., and Hardcastle-Kille, S., "Lightweight Directory Access Protocol", OSI-DS-26, April 1992.

Howes, T., Hardcastle-Kille, S., Yeong, W., and Robbins, C., "Lightweight Directory Access Protocol", OSI-DS-26, April 1992.

Hardcastle-Kille, S., "A String Representation of Distinguished Names", OSI-DS-23, April 1992.

Information Processing - Open Systems Interconnection - The Directory, International Organization for Standardization. International Standard 9594, (1988).