curl_url.3 1.9 KB

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