Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

curl_escape (3)

Name

curl_escape - URL encodes the given string

Synopsis

#include <curl/curl.h>

char *curl_escape(const char *url, int length);

Description

curl_escape(3)                  libcurl Manual                  curl_escape(3)



NAME
       curl_escape - URL encodes the given string

SYNOPSIS
       #include <curl/curl.h>

       char *curl_escape(const char *url, int length);

DESCRIPTION
       Obsolete function. Use curl_easy_escape(3) instead!

       This  function  will  convert  the given input string to an URL encoded
       string and return that as a new allocated string. All input  characters
       that  are  not a-z, A-Z or 0-9 will be converted to their "URL escaped"
       version (%NN where NN is a two-digit hexadecimal number).

       If the lengthf argument is set to 0, curl_escape() will use strlen() on
       the input url string to find out the size.

       You must curl_free(3) the returned string when you are done with it.

EXAMPLE
       char *output = curl_escape("data to convert", 15);
       if(output) {
         printf("Encoded: %s\n", output);
         curl_free(output);
       }

AVAILABILITY
       Since 7.15.4, curl_easy_escape(3) should be used. This function will be
       removed in a future release.

RETURN VALUE
       A pointer to a null-terminated string or NULL if it failed.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       curl_unescape(3), curl_free(3), RFC2396



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021                curl_escape(3)