diff options
Diffstat (limited to 'docs/libcurl/curl_url.3')
| -rw-r--r-- | docs/libcurl/curl_url.3 | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/libcurl/curl_url.3 b/docs/libcurl/curl_url.3 new file mode 100644 index 000000000..0a5626477 --- /dev/null +++ b/docs/libcurl/curl_url.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 curl_url 3 "6 Aug 2018" "libcurl" "libcurl Manual" +.SH NAME +curl_url - returns a new CURLU handle +.SH SYNOPSIS +.B #include <curl/curl.h> + +CURLU *curl_url(); +.SH EXPERIMENTAL +The URL API is considered \fBEXPERIMENTAL\fP until further notice. Please test +it, report bugs and help us perfect it. Once proven to be reliable, the +experimental label will be removed. + +While this API is marked experimental, we reserve the right to modify the API +slightly if we deem it necessary and it makes it notably better or easier to +use. +.SH DESCRIPTION +This function will allocates and returns a pointer to a fresh CURLU handle, to +be used for further use of the URL API. +.SH RETURN VALUE +Returns a \fBCURLU *\fP if successful, or NULL if out of memory. +.SH EXAMPLE +.nf + CURLUcode rc; + CURLU *url = curl_url(); + rc = curl_url_set(url, CURLUPART_URL, "https://example.com", 0); + if(!rc) { + char *scheme; + rc = curl_url_get(url, CURLUPART_SCHEME, &scheme, 0); + if(!rc) { + printf("the scheme is %s\n", scheme); + curl_free(scheme); + } + curl_url_cleanup(url); + } +.fi +.SH AVAILABILITY +Added in curl 7.63.0 +.SH "SEE ALSO" +.BR curl_url_cleanup "(3), " curl_url_get "(3), " curl_url_set "(3), " +.BR curl_url_dup "(3), " |