Skip to content

libcURL.EasyHandle.DataAvailable

Andrew Lambert edited this page Dec 24, 2022 · 32 revisions

libcURL.EasyHandle.DataAvailable

Event Signature

 Event Function DataAvailable(NewData As MemoryBlock) As Integer

Parameters

Name Type Comment
NewData MemoryBlock The data that is available.

Return value

The number of bytes successfully consumed which should be equal to the number of bytes provided. You may also return CURL_WRITEFUNC_PAUSE to consume no data and pause the download; resume the download by calling EasyHandle.Resume.

Remarks

This event handles the CURLOPT_WRITEFUNCTION callback if no DownloadStream is specified. The new data is discarded once this event returns.

You must return the number of bytes that were successfully handled; if the number of bytes handled is different from the number of bytes provided then libcURL will assume that an error has occurred. You may also return the special values CURL_WRITEFUNC_PAUSE or CURL_WRITEFUNC_ERROR(libcurl >=7.87.0) to pause or cancel the download, respectively.

See also

Clone this wiki locally