|
Check-in Number:
|
532 | |
| Date: |
2001-Jul-04 16:21:20 (local)
2001-Jul-04 14:21:20 (UTC) |
| User: | simons |
| Branch: | |
| Comment: |
Documented the return code of registered engines incorrectly: The
enigne does not return XDS_OK but the number of bytes it wrote to the
buffer. |
| Tickets: |
|
| Inspections: |
|
| Files: |
|
ossp-pkg/xds/xds.pod 1.2 -> 1.3
--- xds.pod 2001/07/03 11:36:22 1.2
+++ xds.pod 2001/07/04 14:21:20 1.3
@@ -36,10 +36,11 @@
I<buffer>. The encoded/decoded representation must not take up more
than I<size> byte of memory, because that's the maximum I<buffer> can
hold. If the buffer is too small, I<engine> must return
-B<XDS_ERR_OVERFLOW>. In case of no error, I<engine> must return
-B<XDS_OK>. The variable I<engine_context> is passed through to the
-function every time it is called; it is not touched in any way by the
-xds library.
+B<XDS_ERR_OVERFLOW>. In case of no error, I<engine> must return the
+number of bytes it has written to the buffer. (Note that all xds error
+defines are smaller than >0.) The variable I<engine_context> is passed
+through to the function every time it is called; it is not touched in
+any way by the xds library.
A valid name I<name> for a callback function consists of an arbitrary
number of characters from the class [a-zA-Z0-9_-].
|
|
