curl_url.3 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, 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.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .TH curl_url 3 "6 Aug 2018" "libcurl" "libcurl"
  25. .SH NAME
  26. curl_url - returns a new URL handle
  27. .SH SYNOPSIS
  28. .nf
  29. #include <curl/curl.h>
  30. CURLU *curl_url();
  31. .fi
  32. .SH DESCRIPTION
  33. This function will allocates and returns a pointer to a fresh \fICURLU\fP
  34. handle, to be used for further use of the URL API.
  35. .SH EXAMPLE
  36. .nf
  37. CURLUcode rc;
  38. CURLU *url = curl_url();
  39. rc = curl_url_set(url, CURLUPART_URL, "https://example.com", 0);
  40. if(!rc) {
  41. char *scheme;
  42. rc = curl_url_get(url, CURLUPART_SCHEME, &scheme, 0);
  43. if(!rc) {
  44. printf("the scheme is %s\\n", scheme);
  45. curl_free(scheme);
  46. }
  47. curl_url_cleanup(url);
  48. }
  49. .fi
  50. .SH AVAILABILITY
  51. Added in 7.62.0
  52. .SH RETURN VALUE
  53. Returns a \fBCURLU *\fP if successful, or NULL if out of memory.
  54. .SH "SEE ALSO"
  55. .BR curl_url_cleanup "(3), " curl_url_get "(3), " curl_url_set "(3), "
  56. .BR curl_url_dup "(3), " curl_url_strerror "(3), " CURLOPT_CURLU "(3)"