mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-04-12 16:20:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs/libcurl/curl_*escape.3: rename "url" argument to "input"/"string"

Browse Source 
Also reword the DESCRIPTION section to mention "input"/"string" argument
in bold.

Closes #11027
This commit is contained in:
Emanuele Torre 2023-04-26 08:17:57 +02:00 committed by Daniel Stenberg
parent 73b9d7eb0f
commit f5c36bf6fe
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
3 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/libcurl/curl_easy_unescape.3
View File

@ -33,13 +33,13 @@ char *curl_easy_unescape(CURL *curl, const char *input,
int inlength, int *outlength);
.fi
.SH DESCRIPTION
This function converts the given URL encoded \fBinput\fP string to a "plain
string" and returns that in an allocated memory area. All input characters
that are URL encoded (%XX where XX is a two-digit hexadecimal number) are
converted to their binary versions.
This function converts the URL encoded string \fBinput\fP to a "plain string"
and returns that in an allocated memory area. All input characters that are URL
encoded (%XX where XX is a two-digit hexadecimal number) are converted to their
binary versions.
If the \fBlength\fP argument is set to 0 (zero), \fIcurl_easy_unescape(3)\fP
will use strlen() on the input \fBurl\fP string to find out the size.
will use strlen() on \fBinput\fP to find out the size.
If \fBoutlength\fP is non-NULL, the function will write the length of the
returned string in the integer it points to. This allows proper handling even

12
docs/libcurl/curl_escape.3
View File

@ -28,18 +28,18 @@ curl_escape - URL encodes the given string
.nf
#include <curl/curl.h>
char *curl_escape(const char *url, int length);
char *curl_escape(const char *string, int length);
.fi
.SH DESCRIPTION
Obsolete function. Use \fIcurl_easy_escape(3)\fP instead!
This function will convert 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 will be converted to their "URL escaped" version (\fB%NN\fP where
\fBNN\fP is a two-digit hexadecimal number).
This function will convert the given input \fBstring\fP 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 will be converted to their "URL escaped" version (\fB%NN\fP
where \fBNN\fP is a two-digit hexadecimal number).
If the \fBlength\fP argument is set to 0, \fIcurl_escape(3)\fP will use
strlen() on the input \fBurl\fP string to find out the size.
strlen() on \fBstring\fP to find out the size.
You must \fIcurl_free(3)\fP the returned string when you are done with it.
.SH EXAMPLE

6
docs/libcurl/curl_unescape.3
View File

@ -28,18 +28,18 @@ curl_unescape - URL decodes the given string
.nf
#include <curl/curl.h>
char *curl_unescape(const char *url, int length);
char *curl_unescape(const char *input, int length);
.fi
.SH DESCRIPTION
Obsolete function. Use \fIcurl_easy_unescape(3)\fP instead!
This function will convert the given URL encoded input string to a "plain
This function will convert the URL encoded string \fBinput\fP to a "plain
string" and return that as a new allocated string. All input characters that
are URL encoded (%XX where XX is a two-digit hexadecimal number) will be
converted to their plain text versions.
If the \fBlength\fP argument is set to 0, \fIcurl_unescape(3)\fP will use
strlen() on the input \fBurl\fP string to find out the size.
strlen() on \fBinput\fP to find out the size.
You must \fIcurl_free(3)\fP the returned string when you are done with it.
.SH EXAMPLE