mirror of
https://codeberg.org/kiss-community/repo
synced 2024-12-23 07:40:11 -07:00
46 lines
1.3 KiB
Groff
46 lines
1.3 KiB
Groff
.\" generated by cd2nroff 0.1 from curl_escape.md
|
|
.TH curl_escape 3 "2024-08-02" libcurl
|
|
.SH NAME
|
|
curl_escape \- URL encode a string
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
char *curl_escape(const char *string, int length);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Obsolete function. Use \fIcurl_easy_escape(3)\fP instead!
|
|
|
|
This function converts 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 are 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 uses 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 PROTOCOLS
|
|
This functionality affects all supported protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
char *output = curl_escape("data to convert", 15);
|
|
if(output) {
|
|
printf("Encoded: %s\\n", output);
|
|
curl_free(output);
|
|
}
|
|
}
|
|
.fi
|
|
.SH HISTORY
|
|
Since 7.15.4, \fIcurl_easy_escape(3)\fP should be used. This function might be
|
|
removed in a future release.
|
|
.SH AVAILABILITY
|
|
Added in curl 7.1
|
|
.SH RETURN VALUE
|
|
A pointer to a null\-terminated string or NULL if it failed.
|
|
.SH SEE ALSO
|
|
.BR curl_free (3),
|
|
.BR curl_unescape (3)
|