ldap_init_searchprefs(3ldap)

1ldap_searchprefs(3LDAP)     LDAP Library Functions     ldap_searchprefs(3LDAP)
2
3
4

NAME

6       ldap_searchprefs,   ldap_init_searchprefs,   ldap_init_searchprefs_buf,
7       ldap_free_searchprefs, ldap_first_searchobj, ldap_next_searchobj - LDAP
8       search preference configuration routeines
9

SYNOPSIS

11       cc[ flag... ] file... -lldap[ library... ]
12       # include <lber.h>
13       # include <ldap.h>
14
15       int ldap_init_searchprefs(char **file,
16            struct ldap_searchobj ***solistp);
17
18
19       int ldap_init_searchprefs_buf(char **buf, unsigned longlen,
20            struct ldap_searchobj **solistp);
21
22
23       struct ldap_searchobj **ldap_free_searchprefs
24            (struct ldap_searchobj **solist);
25
26
27       struct ldap_searchobj **ldap_first_searchobj
28            (struct ldap_seachobj **solist);
29
30
31       struct ldap_searchobj **ldap_next_searchobj
32            (struct ldap_seachobj **solist, struct ldap_seachobj **so);
33
34

DESCRIPTION

36       These functions provide a standard way to access LDAP search preference
37       configuration data.  LDAP search preference  configurations  are  typi‐
38       cally  used  by LDAP client programs to specify which attributes a user
39       may search by, labels for the attributes, and LDAP filters  and  scopes
40       associated with those searches.  Client software presents these choices
41       to a user, who can then specify the type of search to be performed.
42
43
44       ldap_init_searchprefs() reads a sequence of search preference  configu‐
45       rations   from   a  valid  LDAP   searchpref  configuration  file.  See
46       ldapsearchprefs.conf(4). Upon success, 0 is returned and solistp is set
47       to point to a list of search preference data structures.
48
49
50       ldap_init_searchprefs_buf()  reads a sequence of search preference con‐
51       figurations from buf, whose size is buflen. buf  should  point  to  the
52       data  in the format defined for an LDAP search preference configuration
53       file. See  ldapsearchprefs.conf(4). Upon success,  0  is  returned  and
54       solistp is set to point to a list of search preference data structures.
55
56
57       ldap_free_searchprefs()  disposes  of  the data structures allocated by
58       ldap_init_searchprefs().
59
60
61       ldap_first_searchpref() returns the first search preference data struc‐
62       ture  in  the  list solist. The solist is typically obtained by calling
63       ldap_init_searchprefs().
64
65
66       ldap_next_searchpref() returns the search preference after  so  in  the
67       template  list  solist.  A  NULL  pointer is returned if so is the last
68       entry in the list.
69

ERRORS

71       ldap_init_search_prefs() and ldap_init_search_prefs_bufs() return:
72
73       LDAP_SEARCHPREF_ERR_VERSION
74
75           **buf points to data that is newer than can be handled.
76
77
78       LDAP_SEARCHPREF_ERR_MEM
79
80           Memory allocation problem.
81
82

ATTRIBUTES

84       See attributes(5) for a description of the following attributes:
85
86
87
88
89       ┌─────────────────────────────┬─────────────────────────────┐
90       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
91       │Availability                 │SUNWcsl (32-bit)             │
92       │                             │SUNWcslx (64-bit)            │
93       │Interface Stability          │Evolving                     │
94       └─────────────────────────────┴─────────────────────────────┘
95

NAME

SYNOPSIS

DESCRIPTION

ERRORS

ATTRIBUTES

SEE ALSO