curl_easy_setopt.3: slight clarification of SEEKFUNCTION

This commit is contained in:
Daniel Stenberg 2013-09-30 14:58:06 +02:00
parent ca995010d0
commit c8b05b809e

View File

@ -260,9 +260,9 @@ used to fast forward a file in a resumed upload (instead of reading all
uploaded bytes with the normal read function/callback). It is also called to uploaded bytes with the normal read function/callback). It is also called to
rewind a stream when doing a HTTP PUT or POST with a multi-pass authentication rewind a stream when doing a HTTP PUT or POST with a multi-pass authentication
method. The function shall work like "fseek" or "lseek" and accepted SEEK_SET, method. The function shall work like "fseek" or "lseek" and accepted SEEK_SET,
SEEK_CUR and SEEK_END as argument for origin, although (in 7.18.0) libcurl SEEK_CUR and SEEK_END as argument for origin, although libcurl currently only
only passes SEEK_SET. The callback must return 0 (CURL_SEEKFUNC_OK) on passes SEEK_SET. The callback must return 0 (CURL_SEEKFUNC_OK) on success, 1
success, 1 (CURL_SEEKFUNC_FAIL) to cause the upload operation to fail or 2 (CURL_SEEKFUNC_FAIL) to cause the upload operation to fail or 2
(CURL_SEEKFUNC_CANTSEEK) to indicate that while the seek failed, libcurl is (CURL_SEEKFUNC_CANTSEEK) to indicate that while the seek failed, libcurl is
free to work around the problem if possible. The latter can sometimes be done free to work around the problem if possible. The latter can sometimes be done
by instead reading from the input or similar. by instead reading from the input or similar.