mirror of
https://github.com/curl/curl.git
synced 2024-12-27 06:59:43 +08:00
8ef2992e11
- expand and clarify several descriptions - avoid using future tense all over Closes #11708
63 lines
2.2 KiB
Groff
63 lines
2.2 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 curl_url 3 "6 Aug 2018" "libcurl" "libcurl"
|
|
.SH NAME
|
|
curl_url - returns a new URL handle
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLU *curl_url();
|
|
.fi
|
|
.SH DESCRIPTION
|
|
This function allocates a URL object and returns a \fICURLU\fP handle for it,
|
|
to be used as input to all other URL API functions.
|
|
|
|
This is a handle to a URL object that holds or can hold URL components for a
|
|
single URL. When the object is first created, there is of course no components
|
|
stored. They are then set in the object with the \fIcurl_url_set(3)\fP
|
|
function.
|
|
.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 7.62.0
|
|
.SH RETURN VALUE
|
|
Returns a \fBCURLU *\fP if successful, or NULL if out of memory.
|
|
.SH "SEE ALSO"
|
|
.BR curl_url_cleanup "(3), " curl_url_get "(3), " curl_url_set "(3), "
|
|
.BR curl_url_dup "(3), " curl_url_strerror "(3), " CURLOPT_CURLU "(3)"
|