curl_unescape.3 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2020, 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_unescape 3 "22 March 2001" "libcurl 7.7" "libcurl Manual"
  23. .SH NAME
  24. curl_unescape - URL decodes the given string
  25. .SH SYNOPSIS
  26. .B #include <curl/curl.h>
  27. .sp
  28. .BI "char *curl_unescape( const char *" url ", int "length " );"
  29. .ad
  30. .SH DESCRIPTION
  31. Obsolete function. Use \fIcurl_easy_unescape(3)\fP instead!
  32. This function will convert the given URL encoded input string to a "plain
  33. string" and return that as a new allocated string. All input characters that
  34. are URL encoded (%XX where XX is a two-digit hexadecimal number) will be
  35. converted to their plain text versions.
  36. If the 'length' argument is set to 0, curl_unescape() will use strlen() on the
  37. input 'url' string to find out the size.
  38. You must \fIcurl_free(3)\fP the returned string when you're done with it.
  39. .SH AVAILABILITY
  40. Since 7.15.4, \fIcurl_easy_unescape(3)\fP should be used. This function will
  41. be removed in a future release.
  42. .SH RETURN VALUE
  43. A pointer to a null-terminated string or NULL if it failed.
  44. .SH "SEE ALSO"
  45. .br curl_easy_escape "(3)," curl_easy_unescape "(3)," curl_free "(3)," RFC 2396