apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jor...@apache.org
Subject svn commit: r290556 - /apr/apr-util/trunk/include/apr_buckets.h
Date Tue, 20 Sep 2005 20:30:16 GMT
Author: jorton
Date: Tue Sep 20 13:30:13 2005
New Revision: 290556

URL: http://svn.apache.org/viewcvs?rev=290556&view=rev
Log:
* include/apr_buckets.h (apr_brigade_partition): Document the return
value semantics.

Modified:
    apr/apr-util/trunk/include/apr_buckets.h

Modified: apr/apr-util/trunk/include/apr_buckets.h
URL: http://svn.apache.org/viewcvs/apr/apr-util/trunk/include/apr_buckets.h?rev=290556&r1=290555&r2=290556&view=diff
==============================================================================
--- apr/apr-util/trunk/include/apr_buckets.h (original)
+++ apr/apr-util/trunk/include/apr_buckets.h Tue Sep 20 13:30:13 2005
@@ -697,6 +697,10 @@
  * @param b The brigade to partition
  * @param point The offset at which to partition the brigade
  * @param after_point Returns a pointer to the first bucket after the partition
+ * @return APR_SUCCESS on success, APR_INCOMPLETE if the contents of the
+ * brigade were shorter than @a point, or an error code.
+ * @remark if APR_INCOMPLETE is returned, @a after_point will be set to
+ * the brigade sentinel.
  */
 APU_DECLARE(apr_status_t) apr_brigade_partition(apr_bucket_brigade *b,
                                                 apr_off_t point,



Mime
View raw message