MAN page from RedHat Other ldap-devel-3.3-3.i386.rpm

SEARCHPREFS

Section: C Library Functions (3)
Updated: 13 June 1994
Index

NAME

ldap_init_searchprefs, ldap_init_searchprefs_buf, ldap_free_searchprefs, ldap_first_searchobj, ldap_next_searchobj - LDAP search preference configuration routeines

SYNOPSIS

#include <srchpref.h>

struct ldap_searchattr {        char                            *sa_attrlabel;        char                            *sa_attr;                                        /* max 32 matchtypes for now */        u_long                          sa_matchtypebitmap;        char                            *sa_selectattr;        char                            *sa_selecttext;        struct ldap_searchattr          *sa_next;};struct ldap_searchmatch {        char                            *sm_matchprompt;        char                            *sm_filter;        struct ldap_searchmatch         *sm_next;};struct ldap_searchobj {        char                            *so_objtypeprompt;        unsigned long                   so_options;        char                            *so_prompt;        short                           so_defaultscope;        char                            *so_filterprefix;        char                            *so_filtertag;        char                            *so_defaultselectattr;        char                            *so_defaultselecttext;        struct ldap_searchattr          *so_salist;        struct ldap_searchmatch         *so_smlist;        struct ldap_searchobj           *so_next;};

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

int ldap_init_searchprefs_buf( buf, buflen, solistp )        char            *buf;        unsigned long   len;        struct ldap_searchobj   **solistp;

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

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

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

DESCRIPTION

These functions provide a standard way to access LDAP search preferenceconfiguration data. LDAP search preference configurations are typicallyused by LDAP client programs to specify which attributes a user maysearch by, labels for the attributes, and LDAP filters and scopesassociated with those searches. Client software presents these choicesto 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))Zerois returned upon success, and solistpis set to point to a list of search preference data structures.

ldap_init_searchprefs_buf()reads a sequence of search preference configurations frombuf(whose size isbuflen).bufshould point to the data in the format defined for an LDAP search preference configuration file (see ldapsearchprefs.conf(5))Zerois returned upon success, and solistpis set to point to a list of search preference data structures.

ldap_free_searchprefs()disposes of the data structures allocated byldap_init_searchprefs().

ldap_first_searchpref()returns the first search preference data structure in the listsolist.Thesolistis typically obtained by callingldap_init_searchprefs().

ldap_next_searchpref()returns the search preference aftersoin the template listsolist. ANULLpointer is returned ifsois the last entry in the list.

ERRORS

The init preferences functions returnLDAP_SEARCHPREF_ERR_VERSIONif buf points to data that is newer than can be handled, andLDAP_SEARCHPREF_ERR_MEMif there is a memory allocation problem.

NOTES

This document was created byman2html,using the manual pages.