curl / libcurl / API / curl_easy_setopt / CURLOPT_CURLU

CURLOPT_CURLU explained

Name

CURLOPT_CURLU - URL in URL handle format

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CURLU, CURLU *pointer);

Description

Pass in a pointer to the URL handle to work with. The parameter should be a CURLU *. Setting CURLOPT_CURLU explicitly overrides CURLOPT_URL.

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

libcurl uses this handle and its contents read-only and does 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 used in a subsequent request the updated contents is 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.