mirror of
https://github.com/curl/curl.git
synced 2026-04-15 01:05:56 +08:00
92e6782d1f
Some public prototypes do not declare return values or out parameters as const where they should be. Avoid changing the public interface, but document those values as read-only. Closes #19692
67 lines
1.3 KiB
Markdown
67 lines
1.3 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_escape
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- curl_free (3)
|
|
- curl_unescape (3)
|
|
Protocol:
|
|
- All
|
|
Added-in: 7.1
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_escape - URL encode a string
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
char *curl_escape(const char *string, int length);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
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%
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
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(3) should be used. This function might be
|
|
removed in a future release.
|
|
|
|
# %AVAILABILITY%
|
|
|
|
# RETURN VALUE
|
|
|
|
A pointer to a null-terminated string or NULL if it failed.
|