LDAP Library Functions                    ldapsearchprefs(3LDAP)



NAME
     ldapsearchprefs,                     ldapinitsearchprefs,
     ldapinitsearchprefsbuf,            ldapfreesearchprefs,
     ldapfirstsearchobj,  ldapnextsearchobj  -  LDAP   search
     preference configuration routeines

SYNOPSIS
     cc[ flag... ] file... -lldap[ library... ]
     # include 
     # include 

     int ldapinitsearchprefs(char **file,
          struct ldapsearchobj ***solistp);


     int ldapinitsearchprefsbuf(char **buf, unsigned longlen,
          struct ldapsearchobj **solistp);


     struct ldapsearchobj **ldapfreesearchprefs
          (struct ldapsearchobj **solist);


     struct ldapsearchobj **ldapfirstsearchobj
          (struct ldapseachobj **solist);


     struct ldapsearchobj **ldapnextsearchobj
          (struct ldapseachobj **solist, struct ldapseachobj **so);


DESCRIPTION
     These functions provide a standard way to access LDAP search
     preference  configuration data.  LDAP search preference con-
     figurations 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  per-
     formed.


     ldapinitsearchprefs() reads a sequence of  search  prefer-
     ence configurations from a valid LDAP  searchpref configura-
     tion file. See  ldapsearchprefs.conf(4). Upon success, 0  is
     returned  and  solistp  is  set to point to a list of search
     preference data structures.


     ldapinitsearchprefsbuf()  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



SunOS 5.11          Last change: 27 Jan 2002                    1






LDAP Library Functions                    ldapsearchprefs(3LDAP)



     LDAP    search    preference    configuration    file.   See
     ldapsearchprefs.conf(4). Upon success,  0  is  returned  and
     solistp  is set to point to a list of search preference data
     structures.


     ldapfreesearchprefs()  disposes  of  the  data  structures
     allocated by ldapinitsearchprefs().


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


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

ERORS
     ldapinitsearchprefs()  and  ldapinitsearchprefsbufs()
     return:

     LDAPSEARCHPREFERVERSION

         **buf points to data that is newer than can be handled.


     LDAPSEARCHPREFERMEM

         Memory allocation problem.


ATRIBUTES
     See attributes(5) for a description of the following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
     Availability                 SUNWcsl (32-bit)            
                                  SUNWcslx (64-bit)           
     Interface Stability          Evolving                    
    


SEE ALSO
     ldap(3LDAP), ldapsearchprefs.conf(4), attributes(5)






SunOS 5.11          Last change: 27 Jan 2002                    2






LDAP Library Functions                    ldapsearchprefs(3LDAP)



     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  Dis-
     tinguished Names", OSI-DS-23, April 1992.


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







































SunOS 5.11          Last change: 27 Jan 2002                    3