curl_escape(3)

curl_escape3

Url encode a string

Usage

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

Overview

Obsolete function. Use curl_easy_escape(3) 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). Although not constrained by its type, the returned string may not be altered.

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

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

Protocols

This functionality affects all supported protocols

Examples

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

Return value

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

Releases

13 releases since Debian 3.0 (Woody); the text changed 10 times.

  1. 3.0
  2. 3.1
  3. 4.0–5.0
  4. 6.0
  5. 7–8
  6. 9
  7. 10
  8. 11
  9. 12
  10. 13
  11. Arch

History

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

Availability

Added in curl 7.1

From curl 8.23.0-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.