]> git.sur5r.net Git - openldap/blobdiff - doc/man/man3/lber-decode.3
Fix LBER_ERROR vs. -1 confusion.
[openldap] / doc / man / man3 / lber-decode.3
index 5e9d28047cde4767daee274bffb078abac7ec987..0494010a43e142963d1313505fd43e48e3e3a11e 100644 (file)
@@ -1,6 +1,6 @@
-.TH LBER_DECODE 3 "19 January 2002" "OpenLDAP LDVERSION"
+.TH LBER_DECODE 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ber_get_next, ber_skip_tag, ber_peek_tag, ber_scanf, ber_get_int,
@@ -8,6 +8,8 @@ ber_get_enum, ber_get_stringb, ber_get_stringa, ber_get_stringal,
 ber_get_stringbv, ber_get_null, ber_get_boolean, ber_get_bitstring,
 ber_first_element, ber_next_element
 \- LBER simplified Basic Encoding Rules library routines for decoding
+.SH LIBRARY
+OpenLDAP LBER (liblber, -llber)
 .SH SYNOPSIS
 .B #include <lber.h>
 .LP
@@ -76,7 +78,9 @@ routine is used to read the next BER element from the given Sockbuf,
 returns the length of the entire element in \fIlen\fP, and sets up
 \fIber\fP for subsequent calls to 
 .BR ber_scanf ()
-et al to decode the element.
+et al to decode the element. See
+.BR lber-sockbuf (3)
+for details of the Sockbuf implementation of the \fIsb\fP parameter.
 .LP
 The
 .BR ber_scanf ()
@@ -332,7 +336,7 @@ as follows.
 .fi
 .SH ERRORS
 If an error occurs during decoding, generally these routines return
-LBER_ERROR (\-1).
+LBER_ERROR ((ber_tag_t)\-1).
 .LP
 .SH NOTES
 .LP
@@ -341,8 +345,9 @@ The return values for all of these functions are declared in the
 header file.  Some routines may dynamically allocate memory
 which must be freed by the caller using supplied deallocation routines.
 .SH SEE ALSO
-.BR lber-encode (3)
-.BR lber-memory (3)
+.BR lber-encode (3),
+.BR lber-memory (3),
+.BR lber-sockbuf (3),
 .BR lber-types (3)
 .SH ACKNOWLEDGEMENTS
 .B     OpenLDAP