mingw/share/man/man3/curl_easy_escape.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: curl_easy_escape.3,v 1.2 2008-04-09 11:27:47 bagder Exp $\r
  22 .\" **************************************************************************\r
  23 .\"\r
  24 .TH curl_easy_escape 3 "7 April 2006" "libcurl 7.15.4" "libcurl Manual"\r
  25 .SH NAME\r
  26 curl_easy_escape - URL encodes the given string\r
  27 .SH SYNOPSIS\r
  28 .B #include <curl/curl.h>\r
  29 .sp\r
  30 .BI "char *curl_easy_escape( CURL *" curl ", char *" url ", int "length " );"\r
  31 .ad\r
  32 .SH DESCRIPTION\r
  33 This function converts the given input string to an URL encoded string and\r
  34 returns that as a new allocated string. All input characters that are not a-z,\r
  35 A-Z or 0-9 are converted to their "URL escaped" version (%NN where NN is a\r
  36 two-digit hexadecimal number).\r
  37 \r
  38 If the \fBlength\fP argument is set to 0 (zero), \fIcurl_easy_escape(3)\fP\r
  39 uses strlen() on the input \fBurl\fP to find out the size.\r
  40 \r
  41 You must \fIcurl_free(3)\fP the returned string when you're done with it.\r
  42 .SH AVAILABILITY\r
  43 Added in 7.15.4 and replaces the old \fIcurl_escape(3)\fP function.\r
  44 .SH RETURN VALUE\r
  45 A pointer to a zero terminated string or NULL if it failed.\r
  46 .SH "SEE ALSO"\r
  47 .BR curl_easy_unescape "(3), " curl_free "(3), " RFC 2396\r