summaryrefslogtreecommitdiffstats
path: root/src/civetweb/docs/api/mg_url_encode.md
blob: 465af122686ec80b802f7816460a0e08c8917afc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Civetweb API Reference

### `mg_url_encode( src, dst, des_len );`

### Parameters

| Parameter | Type | Description |
| :--- | :--- | :--- |
|**`src`**|`const char *`|Input string to encode|
|**`dst`**|`char *`|Destination buffer to store the encoded result|
|**`dst_len`**|`size_t`|Length of the destination buffer including the terminating NUL|

### Return Value

| Type | Description |
| :--- | :--- |
|`int`|The number of characters written in the destination buffer|

### Description

The function `mg_url_encode()` encodes a in input buffer. Both normal URIs and form URIs can be encoded. In the latter case the space character is converted to a `+` as defined in [RFC 1866](http://ftp.ics.uci.edu/pub/ietf/html/rfc1866.txt) in section 8.2.1.

### See Also

* [`mg_url_decode();`](mg_url_decode.md)