diff options
| author | Jim Fuller <jim@webcomposite.com> | 2018-11-01 19:16:15 +0100 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2018-11-09 15:47:28 +0100 |
| commit | 5c4fe0d8264a4a4f591d79cefe9676b099bdecf2 (patch) | |
| tree | d33052e3032909ef366f705e9876780aec64b72f /docs/libcurl/opts | |
| parent | 073332b52515391338cff7bbe407d126fdf9c893 (diff) | |
setopt: add CURLOPT_CURLU
Allows an application to pass in a pre-parsed URL via a URL handle.
Closes #3227
Diffstat (limited to 'docs/libcurl/opts')
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_CURLU.3 | 61 | ||||
| -rw-r--r-- | docs/libcurl/opts/Makefile.inc | 1 |
2 files changed, 62 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_CURLU.3 b/docs/libcurl/opts/CURLOPT_CURLU.3 new file mode 100644 index 000000000..5c762c9a1 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_CURLU.3 @@ -0,0 +1,61 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2018, 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.haxx.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. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_CURLU 3 "28 Oct 2018" "libcurl 7.63.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_CURLU \- set URL with CURLU * +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CURLU, void *pointer); +.SH DESCRIPTION +Pass in a pointer to the \fIURL\fP to work with. The parameter should be a +CURLU *. Setting \fICURLOPT_CURLU(3)\fP will explicitly override \fICURLOPT_URL(3)\fP. + +.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, "http://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 CURLOPT_URL "(3), " +.BR curl_url "(3), " curl_url_get "(3), " curl_url_set "(3), " diff --git a/docs/libcurl/opts/Makefile.inc b/docs/libcurl/opts/Makefile.inc index 117842dc3..e58db5f4a 100644 --- a/docs/libcurl/opts/Makefile.inc +++ b/docs/libcurl/opts/Makefile.inc @@ -111,6 +111,7 @@ man_MANS = \ CURLOPT_CRLF.3 \ CURLOPT_CRLFILE.3 \ CURLOPT_CUSTOMREQUEST.3 \ + CURLOPT_CURLU.3 \ CURLOPT_DEBUGDATA.3 \ CURLOPT_DEBUGFUNCTION.3 \ CURLOPT_DEFAULT_PROTOCOL.3 \ |