Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_CURLU (3)

Name

CURLOPT_CURLU - URL in CURLU * format

Synopsis

#include <curl/curl.h>

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

Description

CURLOPT_CURLU(3)           curl_easy_setopt options           CURLOPT_CURLU(3)



NAME
       CURLOPT_CURLU - URL in CURLU * format

SYNOPSIS
       #include <curl/curl.h>

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

DESCRIPTION
       Pass  in  a  pointer to the URL to work with. The parameter should be a
       CURLU  *.  Setting  CURLOPT_CURLU(3)  will  explicitly  override   CUR-
       LOPT_URL(3).

       CURLOPT_URL(3)  or  CURLOPT_CURLU(3)  must  be set before a transfer is
       started.

       libcurl will use this handle and its contents read-only  and  will  not
       change  its contents. An application can update the contents of the URL
       handle after a transfer is done and if the same handle is then used  in
       a subsequent request the updated contents will then be used.

DEFAULT
       The default value of this parameter is NULL.

PROTOCOLS
       All

EXAMPLE
       CURL *handle = curl_easy_init();
       CURLU *urlp = curl_url();
       int res = 0;
       if(curl) {

         res = curl_url_set(urlp, CURLUPART_URL, "https://example.com", 0);

         curl_easy_setopt(handle, CURLOPT_CURLU, urlp);

         ret = curl_easy_perform(handle);

         curl_url_cleanup(urlp);
         curl_easy_cleanup(handle);
       }

AVAILABILITY
       Added in 7.63.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_URL(3),    curl_url(3),    curl_url_get(3),    curl_url_set(3),
       curl_url_dup(3), curl_url_cleanup(3), curl_url_strerror(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_CURLU(3)