Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

curl_easy_unescape (3)

Name

curl_easy_unescape - URL decodes the given string

Synopsis

#include <curl/curl.h>

char *curl_easy_unescape(CURL *curl, const char *url,
int inlength, int *outlength);

Description

curl_easy_unescape(3)           libcurl Manual           curl_easy_unescape(3)



NAME
       curl_easy_unescape - URL decodes the given string

SYNOPSIS
       #include <curl/curl.h>

       char *curl_easy_unescape(CURL *curl, const char *url,
                                int inlength, int *outlength);

DESCRIPTION
       This  function  converts the given URL encoded input string to a "plain
       string" and returns that in an allocated memory area. All input charac-
       ters that are URL encoded (%XX where XX is a two-digit hexadecimal num-
       ber) are converted to their binary versions.

       If the length argument is set to 0 (zero),  curl_easy_unescape(3)  will
       use strlen() on the input url string to find out the size.

       If  outlength  is  non-NULL,  the function will write the length of the
       returned string in the integer it points to.  This  allows  an  escaped
       string  containing  %00  to  still  get used properly after unescaping.
       Since this is a pointer to an int type, it can only return a  value  up
       to INT_MAX so no longer string can be unescaped if the string length is
       returned in this parameter.

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

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         int decodelen;
         char *decoded = curl_easy_unescape(curl, "%63%75%72%6c", 12, &decodelen);
         if(decoded) {
           /* do not assume printf() works on the decoded data! */
           printf("Decoded: ");
           /* ... */
           curl_free(decoded);
         }
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.15.4 and replaces the old curl_unescape(3) function.

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_easy_escape(3), curl_free(3),RFC3986



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                 December 06, 2021         curl_easy_unescape(3)