docs/libcurl/curl_easy_unescape.3

   1 .\" **************************************************************************\r
   2 .\" *                                  _   _ ____  _\r
   3 .\" *  Project                     ___| | | |  _ \| |\r
   4 .\" *                             / __| | | | |_) | |\r
   5 .\" *                            | (__| |_| |  _ <| |___\r
   6 .\" *                             \___|\___/|_| \_\_____|\r
   7 .\" *\r
   8 .\" * Copyright (C) 1998 - 2008, Daniel Stenberg, <daniel@haxx.se>, et al.\r
   9 .\" *\r
  10 .\" * This software is licensed as described in the file COPYING, which\r
  11 .\" * you should have received as part of this distribution. The terms\r
  12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.\r
  13 .\" *\r
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell\r
  15 .\" * copies of the Software, and permit persons to whom the Software is\r
  16 .\" * furnished to do so, under the terms of the COPYING file.\r
  17 .\" *\r
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY\r
  19 .\" * KIND, either express or implied.\r
  20 .\" *\r
  21 .\" * $Id$\r
  22 .\" **************************************************************************\r
  23 .\"\r
  24 .TH curl_easy_unescape 3 "7 April 2006" "libcurl 7.15.4" "libcurl Manual"\r
  25 .SH NAME\r
  26 curl_easy_unescape - URL decodes the given string\r
  27 .SH SYNOPSIS\r
  28 .B #include <curl/curl.h>\r
  29 .sp\r
  30 .BI "char *curl_easy_unescape( CURL *" curl ", char *" url ", int "inlength\r
  31 .BI ", int *" outlength " );"\r
  32 .ad\r
  33 .SH DESCRIPTION\r
  34 This function converts the given URL encoded input string to a "plain string"\r
  35 and returns that in an allocated memory area. All input characters that are\r
  36 URL encoded (%XX where XX is a two-digit hexadecimal number) are converted to\r
  37 their binary versions.\r
  38 \r
  39 If the \fBlength\fP argument is set to 0 (zero), \fIcurl_easy_unescape(3)\fP\r
  40 will use strlen() on the input \fIurl\fP string to find out the size.\r
  41 \r
  42 If \fBoutlength\fP is non-NULL, the function will write the length of the\r
  43 returned string in the integer it points to. This allows an escaped string\r
  44 containing %00 to still get used properly after unescaping.\r
  45 \r
  46 You must \fIcurl_free(3)\fP the returned string when you're done with it.\r
  47 .SH AVAILABILITY\r
  48 Added in 7.15.4 and replaces the old \fIcurl_unescape(3)\fP function.\r
  49 .SH RETURN VALUE\r
  50 A pointer to a zero terminated string or NULL if it failed.\r
  51 .SH "SEE ALSO"\r
  52 .I curl_easy_escape(3), curl_free(3), RFC 2396\r