79 lines
2.5 KiB
Groff
79 lines
2.5 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is licensed as described in the file COPYING, which
|
||
|
|
.\" * you should have received as part of this distribution. The terms
|
||
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
||
|
|
.\" *
|
||
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
||
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
|
|
.\" * KIND, either express or implied.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_CURLU 3 "28 Oct 2018" libcurl 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 *\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
|
||
|
|
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);
|
||
|
|
}
|
||
|
|
.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 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),
|
||
|
|
.BR CURLOPT_URL (3)
|