Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_PREREQDATA (3)

Name

CURLOPT_PREREQDATA - request callback

Synopsis

#include <curl/curl.h>

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

Description

CURLOPT_PREREQDATA(3)      curl_easy_setopt options      CURLOPT_PREREQDATA(3)



NAME
       CURLOPT_PREREQDATA - pointer passed to the pre-request callback

SYNOPSIS
       #include <curl/curl.h>

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

DESCRIPTION
       Pass  a  pointer  that  will  be untouched by libcurl and passed as the
       first argument in the pre-request callback set with CURLOPT_PREREQFUNC-
       TION(3).

DEFAULT
       NULL

PROTOCOLS
       All

EXAMPLE
       static int prereq_callback(void *clientp,
                                  char *conn_primary_ip,
                                  char *conn_local_ip,
                                  int conn_primary_port,
                                  int conn_local_port)
       {
         printf("Connection made to %s:%s\n", conn_primary_ip, conn_primary_port);
         return CURL_PREREQFUNC_OK;
       }

       {
         struct data prereq_data;
         curl_easy_setopt(CURL *handle, CURLOPT_PREREQFUNCTION, prereq_callback);
         curl_easy_setopt(CURL *handle, CURLOPT_PREREQDATA, &prereq_data);
       }

AVAILABILITY
       Added in 7.80.0

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_PREREQFUNCTION(3)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                 November 26, 2021         CURLOPT_PREREQDATA(3)