Check-in Number:
|
2602 | |
Date: |
2002-Oct-17 15:15:07 (local)
2002-Oct-17 13:15:07 (UTC) |
User: | thl |
Branch: | |
Comment: |
mention callback returning AL_ERR_EOF |
Tickets: |
|
Inspections: |
|
Files: |
|
ossp-pkg/sio/al.pod 1.5 -> 1.6
--- al.pod 2002/10/17 12:23:13 1.5
+++ al.pod 2002/10/17 13:15:07 1.6
@@ -299,8 +299,10 @@
B<al_traverse_cb> is a wrapper function that does a full list traversal in
a single call. In every step a chunk descriptor is passed to the callback
function I<cb> together with a user supplied pointer I<u>. When the
-callback function returns anything but AL_OK the traversal is aborted
-and B<al_traverse_cb> returns with that result code.
+callback function returns AL_OK the traversal continues, when it returns
+AL_ERR_EOF the traversal is aborted and AL_OK is returned to the original
+caller. Any other return code returned by the callback is passed to the
+original caller verbatim.
=back
|
|