Sponsor:

Your company here ā€” click to reach over 10,000 unique daily visitors

CURLOPT_IOCTLDATA - Man Page

pointer passed to I/O callback

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IOCTLDATA, void *pointer);

Description

Pass the pointer that is untouched by libcurl and passed as the 3rd argument in the ioctl callback set with CURLOPT_IOCTLFUNCTION(3).

Default

By default, the value of this parameter is NULL.

Protocols

All

Example

#include <unistd.h> /* for lseek */

struct data {
  int fd; /* our file descriptor */
};

static curlioerr ioctl_callback(CURL *handle, int cmd, void *clientp)
{
  struct data *io = (struct data *)clientp;
  if(cmd == CURLIOCMD_RESTARTREAD) {
    lseek(io->fd, 0, SEEK_SET);
    return CURLIOE_OK;
  }
  return CURLIOE_UNKNOWNCMD;
}
int main(void)
{
  struct data ioctl_data;
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_IOCTLFUNCTION, ioctl_callback);
    curl_easy_setopt(curl, CURLOPT_IOCTLDATA, &ioctl_data);
  }
}

Availability

Added in 7.12.3. Deprecated since 7.18.0.

Return Value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

See Also

CURLOPT_IOCTLFUNCTION(3), CURLOPT_SEEKFUNCTION(3)

Referenced By

curl_easy_setopt(3), CURLOPT_IOCTLFUNCTION(3).

2024-07-12 libcurl