2
0

curl_easy_escape.3 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2011, 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 http://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. .\"
  23. .TH curl_easy_escape 3 "7 April 2006" "libcurl 7.15.4" "libcurl Manual"
  24. .SH NAME
  25. curl_easy_escape - URL encodes the given string
  26. .SH SYNOPSIS
  27. .B #include <curl/curl.h>
  28. .sp
  29. .BI "char *curl_easy_escape( CURL *" curl ", char *" url ", int "length " );"
  30. .ad
  31. .SH DESCRIPTION
  32. This function converts the given input string to an URL encoded string and
  33. returns that as a new allocated string. All input characters that are not a-z,
  34. A-Z, 0-9, '-', '.', '_' or '~' are converted to their "URL escaped" version
  35. (%NN where NN is a two-digit hexadecimal number).
  36. If the \fBlength\fP argument is set to 0 (zero), \fIcurl_easy_escape(3)\fP
  37. uses strlen() on the input \fBurl\fP 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. Added in 7.15.4 and replaces the old \fIcurl_escape(3)\fP function.
  41. .SH RETURN VALUE
  42. A pointer to a zero terminated string or NULL if it failed.
  43. .SH "SEE ALSO"
  44. .BR curl_easy_unescape "(3), " curl_free "(3), " RFC 2396