-.TH LDAP_ERROR 3 "22 September 1998" "OpenLDAP LDVERSION"
+.TH LDAP_ERROR 3 "23 July 2001" "OpenLDAP LDVERSION"
.\" $OpenLDAP$
.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
#include <ldap.h>
.LP
.ft B
-struct ldaperror {
- int e_code;
- char *e_reason;
-};
-.LP
-.ft B
-struct ldaperror ldap_errlist[];
-.LP
-.ft B
-char *ldap_err2string(err)
+char *ldap_err2string( int err );
.ft
int err;
.LP
.ft B
-void ldap_perror(ld, s)
-.ft
-LDAP *ld;
-char *s;
+void ldap_perror( LDAP *ld, const char *s )
.LP
.ft B
-int ldap_result2error(ld, res, freeit)
-.ft
-LDAP *ld;
-LDAPMessage *res;
-int freeit;
+int ldap_result2error( LDAP *ld, LDAPMessage *res, int freeit )
.SH DESCRIPTION
These routines provide interpretation of the various error codes
returned by the LDAP protocol and LDAP library routines, and assigned
.LP
The returned value can be passed to
.B ldap_err2string()
-or looked up in
-.B ldap_errlist[]
to get a text description of the message. The string
returned from
.B ldap_err2string()
is a pointer to a static area that
-should not be modified. The last element in the
-.B ldap_errlist[]
-array is signaled by an error code of -1.
+should not be modified.
.LP
The
.B ldap_perror()
-.TH LDAP_GETFILTER 3 "22 September 1998" "OpenLDAP LDVERSION"
+.TH LDAP_GETFILTER 3 "23 July 2001" "OpenLDAP LDVERSION"
.\" $OpenLDAP$
.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
#define LDAP_FILT_MAXSIZ 1024
typedef struct ldap_filt_info {
- char *lfi_filter;
- char *lfi_desc;
- int lfi_scope;
- int lfi_isexact;
- struct ldap_filt_info *lfi_next;
+ char *lfi_filter;
+ char *lfi_desc;
+ int lfi_scope;
+ int lfi_isexact;
+ struct ldap_filt_info *lfi_next;
} LDAPFiltInfo;
typedef struct ldap_filt_list {
- char *lfl_tag;
- char *lfl_pattern;
- char *lfl_delims;
- LDAPFiltInfo *lfl_ilist;
- struct ldap_filt_list *lfl_next;
+ char *lfl_tag;
+ char *lfl_pattern;
+ char *lfl_delims;
+ LDAPFiltInfo *lfl_ilist;
+ struct ldap_filt_list *lfl_next;
} LDAPFiltList;
typedef struct ldap_filt_desc {
- LDAPFiltList *lfd_filtlist;
- LDAPFiltInfo *lfd_curfip;
- LDAPFiltInfo lfd_retfi;
- char lfd_filter[ LDAP_FILT_MAXSIZ ];
- char *lfd_curval;
- char *lfd_curvalcopy;
- char **lfd_curvalwords;
- char *lfd_filtprefix;
- char *lfd_filtsuffix;
+ LDAPFiltList *lfd_filtlist;
+ LDAPFiltInfo *lfd_curfip;
+ LDAPFiltInfo lfd_retfi;
+ char lfd_filter[ LDAP_FILT_MAXSIZ ];
+ char *lfd_curval;
+ char *lfd_curvalcopy;
+ char **lfd_curvalwords;
+ char *lfd_filtprefix;
+ char *lfd_filtsuffix;
} LDAPFiltDesc;
.ft
.fi
-.TH LDAP_URL 3 "17 October 2000" "OpenLDAP LDVERSION"
+.TH LDAP_URL 3 "23 July 2001" "OpenLDAP LDVERSION"
.\" $OpenLDAP$
.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
.ft
.LP
.ft B
-int ldap_is_ldap_url( url )
-.ft
-char *url;
+int ldap_is_ldap_url( const char *url )
.LP
.ft B
-int ldap_url_parse( url, ludpp )
-.ft
-char *url;
-LDAPURLDesc **ludpp;
+int ldap_url_parse( const char *url, LDAPURLDesc **ludpp )
.LP
typedef struct ldap_url_desc {
- char * lud_scheme; /* URI scheme */
- char lud_host; /* LDAP host to contact */
- int lud_port; /* port on host */
- char * lud_dn; /* base for search */
- char ** lud_attrs; /* list of attributes */
- int lud_scope; /* a LDAP_SCOPE_... value */
- char * lud_filter; /* LDAP search filter */
- char ** lud_exts; /* LDAP extensions */
+ char * lud_scheme; /* URI scheme */
+ char lud_host; /* LDAP host to contact */
+ int lud_port; /* port on host */
+ char * lud_dn; /* base for search */
+ char ** lud_attrs; /* list of attributes */
+ int lud_scope; /* a LDAP_SCOPE_... value */
+ char * lud_filter; /* LDAP search filter */
+ char ** lud_exts; /* LDAP extensions */
+ int lud_crit_exts; /* true if any extension is critical */
/* may contain additional fields for internal use */
} LDAPURLDesc;
.LP
.ft B
-ldap_free_urldesc( ludp )
-.ft
-LDAPURLDesc *ludp;
+ldap_free_urldesc( LDAPURLDesc *ludp )
.LP
.ft B
int ldap_url_search( ld, url, attrsonly )
.ft
-LDAP *ld;
-char *url;
-int attrsonly;
+LDAP *ld;
+char *url;
+int attrsonly;
.LP
.ft B
int ldap_url_search_s( ld, url, attrsonly, res )
.ft
-LDAP *ld;
-char *url;
-int attrsonly;
-LDAPMessage **res;
+LDAP *ld;
+char *url;
+int attrsonly;
+LDAPMessage **res;
.LP
.ft B
int ldap_url_search_st( ld, url, attrsonly, timeout, res )
.ft
-LDAP *ld;
-char *url;
-int attrsonly;
-struct timeval *timeout;
-LDAPMessage **res;
+LDAP *ld;
+char *url;
+int attrsonly;
+struct timeval *timeout;
+LDAPMessage **res;
.SH DESCRIPTION
These routines support the use of LDAP URLs (Uniform Resource Locators)
as detailed in RFC 2255. LDAP URLs look like this:
.B The LDAP URL Format, RFC 2255,
Tim Howes and Mark Smith, December 1997.
.SH ACKNOWLEDGEMENTS
-.B OpenLDAP
+.B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B OpenLDAP
+.B OpenLDAP
is derived from University of Michigan LDAP 3.3 Release.