| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_CURLU 3 "28 Oct 2018" "libcurl 7.63.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_CURLU \- set URL with CURLU * |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CURLU, void *pointer); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass in a pointer to the \fIURL\fP to work with. The parameter should be a |
| 32 |
CURLU *. Setting \fICURLOPT_CURLU(3)\fP will explicitly override |
| 33 |
\fICURLOPT_URL(3)\fP. |
| 34 |
|
| 35 |
\fICURLOPT_URL(3)\fP or \fICURLOPT_CURLU(3)\fP \fBmust\fP be set before a |
| 36 |
transfer is started. |
| 37 |
|
| 38 |
libcurl will use this handle and its contents read-only and will not change |
| 39 |
its contents. An application can very well update the contents of the URL |
| 40 |
handle after a transfer is done and if the same handle is then used in a |
| 41 |
subsequent request the updated contents will then be used. |
| 42 |
.SH DEFAULT |
| 43 |
The default value of this parameter is NULL. |
| 44 |
.SH PROTOCOLS |
| 45 |
All |
| 46 |
.SH EXAMPLE |
| 47 |
.nf |
| 48 |
CURL *handle = curl_easy_init(); |
| 49 |
CURLU *urlp = curl_url(); |
| 50 |
int res = 0; |
| 51 |
if(curl) { |
| 52 |
|
| 53 |
res = curl_url_set(urlp, CURLUPART_URL, "http://example.com", 0); |
| 54 |
|
| 55 |
curl_easy_setopt(handle, CURLOPT_CURLU, urlp); |
| 56 |
|
| 57 |
ret = curl_easy_perform(handle); |
| 58 |
|
| 59 |
curl_url_cleanup(urlp); |
| 60 |
curl_easy_cleanup(handle); |
| 61 |
} |
| 62 |
.fi |
| 63 |
.SH AVAILABILITY |
| 64 |
Added in 7.63.0. |
| 65 |
.SH RETURN VALUE |
| 66 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 67 |
.SH "SEE ALSO" |
| 68 |
.BR CURLOPT_URL "(3), " |
| 69 |
.BR curl_url "(3), " curl_url_get "(3), " curl_url_set "(3), " |