Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_IOCTLDATA (3)

Name

CURLOPT_IOCTLDATA - custom pointer passed to I/O callback

Synopsis

#include <curl/curl.h>

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

Description

CURLOPT_IOCTLDATA(3)       curl_easy_setopt options       CURLOPT_IOCTLDATA(3)



NAME
       CURLOPT_IOCTLDATA - custom 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 will be 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
       Used with HTTP

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

AVAILABILITY
       Added in 7.12.3

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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_IOCTLFUNCTION(3), CURLOPT_SEEKFUNCTION(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    16 Jun 2014             CURLOPT_IOCTLDATA(3)