docs/libcurl/curl_easy_escape.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 .\"
  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 ", const char *" string
  30 .BI ", int "length " );"
  31 .ad
  32 .SH DESCRIPTION
  33 This function converts the given input \fIstring\fP to a URL encoded string
  34 and returns that as a new allocated string. All input characters that are not
  35 a-z, A-Z, 0-9, '-', '.', '_' or '~' are converted to their "URL escaped"
  36 version (%NN where NN is a two-digit hexadecimal number).
  37
  38 If \fIlength\fP is set to 0 (zero), \fIcurl_easy_escape(3)\fP uses strlen() on
  39 the input \fIstring\fP to find out the size.
  40
  41 You must \fIcurl_free(3)\fP the returned string when you're done with it.
  42 .SH AVAILABILITY
  43 Added in 7.15.4 and replaces the old \fIcurl_escape(3)\fP function.
  44 .SH RETURN VALUE
  45 A pointer to a zero terminated string or NULL if it failed.
  46 .SH EXAMPLE
  47 .nf
  48 CURL *curl = curl_easy_init();
  49 if(curl) {
  50   char *output = curl_easy_escape(curl, "data to convert", 15);
  51   if(output) {
  52     printf("Encoded: %s\\n", output);
  53     curl_free(output);
  54   }
  55 }
  56 .fi
  57 .SH "SEE ALSO"
  58 .BR curl_easy_unescape "(3), " curl_free "(3), " RFC 3986