2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-08-19 12:46:58 +00:00
repo/core/curl/files/CURLOPT_CURLU.3
2024-06-01 15:49:19 -05:00

59 lines
1.5 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_CURLU.md
.TH CURLOPT_CURLU 3 "2024-06-01" 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
The default value of this parameter is NULL.
.SH PROTOCOLS
All
.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 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)