1 .TH SEARCHPREFS 3 "13 June 1994" "U-M LDAP LDVERSION"
3 ldap_init_searchprefs, ldap_init_searchprefs_buf, ldap_free_searchprefs, ldap_first_searchobj, ldap_next_searchobj \- LDAP search preference configuration routeines
13 struct ldap_searchattr {
16 /* max 32 matchtypes for now */
17 u_long sa_matchtypebitmap;
20 struct ldap_searchattr *sa_next;
23 struct ldap_searchmatch {
26 struct ldap_searchmatch *sm_next;
29 struct ldap_searchobj {
30 char *so_objtypeprompt;
31 unsigned long so_options;
33 short so_defaultscope;
34 char *so_filterprefix;
36 char *so_defaultselectattr;
37 char *so_defaultselecttext;
38 struct ldap_searchattr *so_salist;
39 struct ldap_searchmatch *so_smlist;
40 struct ldap_searchobj *so_next;
47 int ldap_init_searchprefs( file, solistp )
49 struct ldap_searchobj \(***solistp;
55 int ldap_init_searchprefs_buf( buf, buflen, solistp )
58 struct ldap_searchobj \(***solistp;
64 struct ldap_searchobj \(**ldap_free_searchprefs( solist )
65 struct ldap_searchobj \(**solist;
71 struct ldap_searchobj \(**ldap_first_searchobj( solist )
72 struct ldap_seachobj \(**solist;
78 struct ldap_searchobj \(**ldap_next_searchobj( solist, so )
79 struct ldap_searchobj \(**solist;
80 struct ldap_searchobj \(**so;
83 These functions provide a standard way to access LDAP search preference
84 configuration data. LDAP search preference configurations are typically
85 used by LDAP client programs to specify which attributes a user may
86 search by, labels for the attributes, and LDAP filters and scopes
87 associated with those searches. Client software presents these choices
88 to a user, who can then specify the type of search to be performed.
90 .B ldap_init_searchprefs(\|)
91 reads a sequence of search preference configurations from a valid LDAP
92 searchpref configuration file
93 (see ldapsearchprefs.conf(5))
95 is returned upon success, and
97 is set to point to a list of search preference data structures.
99 .B ldap_init_searchprefs_buf(\|)
100 reads a sequence of search preference configurations from
105 should point to the data in the format defined for an LDAP search preference
106 configuration file (see ldapsearchprefs.conf(5))
108 is returned upon success, and
110 is set to point to a list of search preference data structures.
113 .B ldap_free_searchprefs(\|)
114 disposes of the data structures allocated by
115 .B ldap_init_searchprefs(\|).
117 .B ldap_first_searchpref(\|)
118 returns the first search preference data structure in the list
122 is typically obtained by calling
123 .B ldap_init_searchprefs(\|).
125 .B ldap_next_searchpref(\|)
126 returns the search preference after
131 pointer is returned if
133 is the last entry in the list.
136 The init preferences functions return
137 .B LDAP_SEARCHPREF_ERR_VERSION
138 if buf points to data that is newer than can be handled, and
139 .B LDAP_SEARCHPREF_ERR_MEM
140 if there is a memory allocation problem.
144 .BR ldapsearchprefs.conf (5),
147 Yeong, W., Howes, T., and Hardcastle-Kille, S., "Lightweight Directory Access
148 Protocol", OSI-DS-26, April 1992.
150 Howes, T., Hardcastle-Kille, S., Yeong, W., and Robbins, C., "Lightweight
151 Directory Access Protocol", OSI-DS-26, April 1992.
153 Hardcastle-Kille, S., "A String Representation of Distinguished Names",
154 OSI-DS-23, April 1992.
156 Information Processing - Open Systems Interconnection - The Directory,
157 International Organization for Standardization. International Standard