curl / libcurl / API / curl_escape

curl_escape - URL encode the given string

Name

curl_escape - URL encode a string

Synopsis

#include <curl/curl.h>
 
char *curl_escape(const char *string, int length);

Description

Obsolete function. Use curl_easy_escape instead.

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

If the length argument is set to 0, curl_escape uses strlen() on string to find out the size.

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

Protocols

This functionality affects all supported protocols

Example

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

History

Since 7.15.4, curl_easy_escape should be used. This function might be removed in a future release.

Availability

Added in curl 7.1

Return value

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