Return to curl_escape.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl

Annotation of embedaddon/curl/docs/libcurl/curl_escape.3, revision 1.1.1.1

1.1       misho       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_escape 3 "March 23, 2020" "libcurl 7.70.0" "libcurl Manual"
                     23: 
                     24: .SH NAME
                     25: curl_escape - URL encodes the given string
                     26: .SH SYNOPSIS
                     27: .B #include <curl/curl.h>
                     28: .sp
                     29: .BI "char *curl_escape( const char *" url ", int "length " );"
                     30: .ad
                     31: .SH DESCRIPTION
                     32: Obsolete function. Use \fIcurl_easy_escape(3)\fP instead!
                     33: 
                     34: This function will convert the given input string to an URL encoded string and
                     35: return that as a new allocated string. All input characters that are not a-z,
                     36: A-Z or 0-9 will be converted to their "URL escaped" version (%NN where NN is a
                     37: two-digit hexadecimal number).
                     38: 
                     39: If the 'length' argument is set to 0, curl_escape() will use strlen() on the
                     40: input 'url' string to find out the size.
                     41: 
                     42: You must \fIcurl_free(3)\fP the returned string when you're done with it.
                     43: .SH AVAILABILITY
                     44: Since 7.15.4, \fIcurl_easy_escape(3)\fP should be used. This function will
                     45: be removed in a future release.
                     46: .SH RETURN VALUE
                     47: A pointer to a zero terminated string or NULL if it failed.
                     48: .SH "SEE ALSO"
                     49: .BR curl_unescape "(3), " curl_free "(3), " RFC 2396