~ubuntu-branches/ubuntu/lucid/curl/lucid-201010031940

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_easy_escape.3

  • Committer: Kees Cook
  • Date: 2009-12-12 04:16:02 UTC
  • mfrom: (3.3.3 squeeze)
  • Revision ID: kees@outflux.net-20091212041602-o707x164tp1f8efj
Merged with Debian testing

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" **************************************************************************
2
 
.\" *                                  _   _ ____  _
3
 
.\" *  Project                     ___| | | |  _ \| |
4
 
.\" *                             / __| | | | |_) | |
5
 
.\" *                            | (__| |_| |  _ <| |___
6
 
.\" *                             \___|\___/|_| \_\_____|
7
 
.\" *
8
 
.\" * Copyright (C) 1998 - 2008, Daniel Stenberg, <daniel@haxx.se>, et al.
9
 
.\" *
10
 
.\" * This software is licensed as described in the file COPYING, which
11
 
.\" * you should have received as part of this distribution. The terms
12
 
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
13
 
.\" *
14
 
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15
 
.\" * copies of the Software, and permit persons to whom the Software is
16
 
.\" * furnished to do so, under the terms of the COPYING file.
17
 
.\" *
18
 
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19
 
.\" * KIND, either express or implied.
20
 
.\" *
21
 
.\" * $Id: curl_easy_escape.3,v 1.2 2008-04-09 11:27:47 bagder Exp $
22
 
.\" **************************************************************************
23
 
.\"
24
 
.TH curl_easy_escape 3 "7 April 2006" "libcurl 7.15.4" "libcurl Manual"
25
 
.SH NAME
26
 
curl_easy_escape - URL encodes the given string
27
 
.SH SYNOPSIS
28
 
.B #include <curl/curl.h>
29
 
.sp
30
 
.BI "char *curl_easy_escape( CURL *" curl ", char *" url ", int "length " );"
31
 
.ad
32
 
.SH DESCRIPTION
33
 
This function converts the given input string to an URL encoded string and
34
 
returns that as a new allocated string. All input characters that are not a-z,
35
 
A-Z or 0-9 are converted to their "URL escaped" version (%NN where NN is a
36
 
two-digit hexadecimal number).
37
 
 
38
 
If the \fBlength\fP argument is set to 0 (zero), \fIcurl_easy_escape(3)\fP
39
 
uses strlen() on the input \fBurl\fP to find out the size.
40
 
 
41
 
You must \fIcurl_free(3)\fP the returned string when you're done with it.
42
 
.SH AVAILABILITY
43
 
Added in 7.15.4 and replaces the old \fIcurl_escape(3)\fP function.
44
 
.SH RETURN VALUE
45
 
A pointer to a zero terminated string or NULL if it failed.
46
 
.SH "SEE ALSO"
47
 
.BR curl_easy_unescape "(3), " curl_free "(3), " RFC 2396
 
1
.\" **************************************************************************
 
2
.\" *                                  _   _ ____  _
 
3
.\" *  Project                     ___| | | |  _ \| |
 
4
.\" *                             / __| | | | |_) | |
 
5
.\" *                            | (__| |_| |  _ <| |___
 
6
.\" *                             \___|\___/|_| \_\_____|
 
7
.\" *
 
8
.\" * Copyright (C) 1998 - 2008, Daniel Stenberg, <daniel@haxx.se>, et al.
 
9
.\" *
 
10
.\" * This software is licensed as described in the file COPYING, which
 
11
.\" * you should have received as part of this distribution. The terms
 
12
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
 
13
.\" *
 
14
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
 
15
.\" * copies of the Software, and permit persons to whom the Software is
 
16
.\" * furnished to do so, under the terms of the COPYING file.
 
17
.\" *
 
18
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 
19
.\" * KIND, either express or implied.
 
20
.\" *
 
21
.\" * $Id: curl_easy_escape.3,v 1.3 2009-05-19 12:48:14 yangtse Exp $
 
22
.\" **************************************************************************
 
23
.\"
 
24
.TH curl_easy_escape 3 "7 April 2006" "libcurl 7.15.4" "libcurl Manual"
 
25
.SH NAME
 
26
curl_easy_escape - URL encodes the given string
 
27
.SH SYNOPSIS
 
28
.B #include <curl/curl.h>
 
29
.sp
 
30
.BI "char *curl_easy_escape( CURL *" curl ", char *" url ", int "length " );"
 
31
.ad
 
32
.SH DESCRIPTION
 
33
This function converts the given input string to an URL encoded string and
 
34
returns that as a new allocated string. All input characters that are not a-z,
 
35
A-Z or 0-9 are converted to their "URL escaped" version (%NN where NN is a
 
36
two-digit hexadecimal number).
 
37
 
 
38
If the \fBlength\fP argument is set to 0 (zero), \fIcurl_easy_escape(3)\fP
 
39
uses strlen() on the input \fBurl\fP to find out the size.
 
40
 
 
41
You must \fIcurl_free(3)\fP the returned string when you're done with it.
 
42
.SH AVAILABILITY
 
43
Added in 7.15.4 and replaces the old \fIcurl_escape(3)\fP function.
 
44
.SH RETURN VALUE
 
45
A pointer to a zero terminated string or NULL if it failed.
 
46
.SH "SEE ALSO"
 
47
.BR curl_easy_unescape "(3), " curl_free "(3), " RFC 2396