mirror of https://github.com/moparisthebest/curl
27 lines
929 B
Groff
27 lines
929 B
Groff
.\" You can view this file with:
|
|
.\" nroff -man [file]
|
|
.\" $Id$
|
|
.\"
|
|
.TH curl_escape 3 "6 March 2002" "libcurl 7.9" "libcurl Manual"
|
|
.SH NAME
|
|
curl_escape - URL encodes the given string
|
|
.SH SYNOPSIS
|
|
.B #include <curl/curl.h>
|
|
.sp
|
|
.BI "char *curl_escape( char *" url ", int "length " );"
|
|
.ad
|
|
.SH DESCRIPTION
|
|
This function will convert the given input string to an 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 (%NN where NN is a
|
|
two-digit hexadecimal number).
|
|
|
|
If the 'length' argument is set to 0, curl_escape() will use strlen() on the
|
|
input 'url' string to find out the size.
|
|
|
|
You must curl_free() the returned string when you're done with it.
|
|
.SH RETURN VALUE
|
|
A pointer to a zero terminated string or NULL if it failed.
|
|
.SH "SEE ALSO"
|
|
.BR curl_unescape "(3), " curl_free "(3), " RFC 2396
|