| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 |
- .\" generated by cd2nroff 0.1 from CURLOPT_CURLU.md
- .TH CURLOPT_CURLU 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_CURLU \- URL in URL handle format
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CURLU, CURLU *pointer);
- .fi
- .SH DESCRIPTION
- Pass in a pointer to the \fIURL\fP handle to work with. The parameter should be a
- \fICURLU pointer\fP. Setting \fICURLOPT_CURLU(3)\fP explicitly overrides
- \fICURLOPT_URL(3)\fP.
- \fICURLOPT_URL(3)\fP or \fICURLOPT_CURLU(3)\fP \fBmust\fP 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.
- .SH DEFAULT
- NULL
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- CURLU *urlp = curl_url();
- if(curl) {
- CURLcode res;
- CURLUcode ret;
- ret = curl_url_set(urlp, CURLUPART_URL, "https://example.com", 0);
- curl_easy_setopt(curl, CURLOPT_CURLU, urlp);
- res = curl_easy_perform(curl);
- curl_url_cleanup(urlp);
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.63.0
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLOPT_URL (3),
- .BR curl_url (3),
- .BR curl_url_cleanup (3),
- .BR curl_url_dup (3),
- .BR curl_url_get (3),
- .BR curl_url_set (3),
- .BR curl_url_strerror (3)
|
