Manual Pages for UNIX Operating System command usage for man ldap_vals2text

LDAP Library Functions                     ldap_entry2text(3LDAP)



NAME
     ldap_entry2text,  ldap_entry2text_search,   ldap_entry2html,
     ldap_entry2html_search,   ldap_vals2html,  ldap_vals2text  -
     LDAP entry display functions

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

     int ldap_entry2text(LDAP *ld, char *buf, LDAPMessage *entry,
          struct ldap_disptmpl *tmpl, char **defattrs, char ***defvals,
          int (*writeproc)(), void *writeparm, char *eol, int rdncount,
          unsigned long opts);


     int ldap_entry2text_search(LDAP *ld, char *dn, char *base,
          LDAPMessage *entry, struct ldap_disptmpl *tmpllist,
          char **defattrs, char ***defvals, int (*writeproc)(),
          void *writeparm, char *eol,int rdncount,
          unsigned long opts);


     int ldap_vals2text(LDAP *ld, char *buf, char **vals, char *label,
          int labelwidth, unsigned longsyntaxid, int (*writeproc)(),
          void *writeparm, char *eol, int rdncount);


     int ldap_entry2html(LDAP *ld, char *buf, LDAPMessage *entry,
          struct ldap_disptmpl *tmpl, char **defattrs, char ***defvals,
          int (*writeproc)(),void *writeparm, char *eol, int rdncount,
          unsigned long opts, char *urlprefix, char *base);


     int ldap_entry2html_search(LDAP *ld, char *dn, LDAPMessage *entry,
          struct ldap_disptmpl *tmpllist, char **defattrs, char ***defvals,
          int (*writeproc)(), void *writeparm, char *eol, int rdncount,
          unsigned long opts, char *urlprefix);


     int ldap_vals2html(LDAP *ld, char *buf, char **vals,
          char *label, int labelwidth, unsigned long syntaxid,
          int (*writeproc)(), void *writeparm, char *eol, int rdncount,
          char *urlprefix);


     #define LDAP_DISP_OPT_AUTOLABELWIDTH 0x00000001


     #define LDAP_DISP_OPT_HTMLBODYONLY      0x00000002





SunOS 5.11          Last change: 27 Jan 2002                    1






LDAP Library Functions                     ldap_entry2text(3LDAP)



     #define LDAP_DTMPL_BUFSIZ  2048


DESCRIPTION
     These functions use the LDAP display template functions (see
     ldap_disptmpl(3LDAP) and  ldap_templates.conf(4)) to produce
     a plain text or an HyperText Markup Language (HTML)  display
     of  an  entry or a set of values.  Typical plain text output
     produced for an entry might look like:

           "Barbara J Jensen, Information Technology Division"
            Also Known As:
            Babs Jensen
            Barbara Jensen
            Barbara J Jensen
            E-Mail Address:
            bjensen@terminator.rs.itd.umich.edu
            Work Address:
            535 W. William
            Ann Arbor, MI 48103
            Title:
            Mythical Manager, Research Systems
            ...



     The exact output produced will depend on  the  display  tem-
     plate  configuration.  HTML  output  is similar to the plain
     text output, but more richly formatted.


     ldap_entry2text() produces a text  representation  of  entry
     and  writes the text by calling the writeproc function.  All
     of the attributes values to be displayed must be present  in
     entry; no interaction with the LDAP server will be performed
     within ldap_entry2text. ld is the LDAP pointer obtained by a
     previous call to ldap_open. writeproc should be declared as:

       int writeproc( writeparm, p, len )
        void  *writeparm;
        char  *p;
        int  len;



     where p is a pointer to text to be written and  len  is  the
     length  of  the text. p is guaranteed to be zero-terminated.
     Lines of text are terminated with the string eol. buf  is  a
     pointer to a buffer of size LDAP_DTMPL_BUFSIZ or larger.  If
     buf is NULL then a buffer is allocated and freed internally.
     tmpl  is  a pointer to the display template to be used (usu-
     ally obtained by calling ldap_oc2template). If tmpl is NULL,



SunOS 5.11          Last change: 27 Jan 2002                    2






LDAP Library Functions                     ldap_entry2text(3LDAP)



     no  template  is  used  and  a  generic display is produced.
     defattrs is a NULL-terminated array of LDAP attribute  names
     which  you  wish to provide default values for (only used if
     entry contains no values for the attribute).   An  array  of
     NULL-terminated  arrays  of  default values corresponding to
     the attributes should be passed  in  defvals.  The  rdncount
     parameter  is used to limit the number of Distinguished Name
     (DN) components that are actually displayed  for  DN  attri-
     butes.   If rdncount is zero, all components are shown. opts
     is  used  to  specify  output  options.   The  only   values
     currently     allowed    are    zero    (default    output),
     LDAP_DISP_OPT_AUTOLABELWIDTH  which  causes  the  width  for
     labels  to be determined based on the longest label in tmpl,
     and             LDAP_DISP_OPT_HTMLBODYONLY.              The
     LDAP_DISP_OPT_HTMLBODYONLY  option instructs the library not
     to include , ,