Changeset 74224 in vbox for trunk/include/iprt/cpp

Timestamp:

Sep 12, 2018 2:44:27 PM (6 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

125006

Message:

IPRT/http,rest: Clearified the content offset parameter in the callbacks.

File:

• trunk/include/iprt/cpp/restclient.h (modified) (2 diffs)

trunk/include/iprt/cpp/restclient.h

@@ -100 +100 @@
      * @param   a_offContent    The byte offset corresponding to the start of @a a_pvDst.
      * @param   a_pcbActual     Where to return the number of bytes actually produced.
+     *
      * @remarks Use getCallbackData to get the user data.
+     *
+     * @note    The @a a_offContent parameter does not imply random access or anthing
+     *          like that, it is just a convenience provided by the caller.  The value
+     *          is the sum of the previously returned @a *pcbActual values.
      */
     typedef DECLCALLBACK(int) FNPRODUCER(RTCRestBinaryParameter *a_pThis, void *a_pvDst, size_t a_cbDst,
@@ -228 +233 @@
      * @param   a_offContent    The byte offset corresponding to the start of @a a_pvSrc.
      * @param   a_cbContent     The content length field value, UINT64_MAX if not available.
+     *
      * @remarks Use getCallbackData to get the user data.
+     *
+     * @note    The @a a_offContent parameter does not imply random access or anthing
+     *          like that, it is just a convenience provided by the caller.  The value
+     *          is the sum of the previous @a a_cbSrc values.
      */
     typedef DECLCALLBACK(int) FNCONSUMER(RTCRestBinaryResponse *a_pThis, const void *a_pvSrc, size_t a_cbSrc,