Debian Codegraph @

src/vendor/azure-uamqp-c/deps/azure-c-shared-utility/devdoc/url_encode_requirements.md

raw
1 url_encode requirements
2 ================
3
4 ## Overview
5
6 This document will specify the requirements for URL_Encode.
7
8 ## Exposed API
9
10 ```c
11 extern STRING* URL_Encode(STRING* input);
12 ```
13
14 ### URL_Encode
15
16 URL_Encode will take as a parameter a pointer to a STRING, input. URL_Encode will return a pointer to STRING.
17 **SRS_URL_ENCODE_06_001: [** If input is NULL then URL_Encode will return NULL. **]**
18
19 **SRS_URL_ENCODE_06_002: [** If an error occurs during the encoding of input then URL_Encode will return NULL. **]**
20
21 **SRS_URL_ENCODE_06_003: [** If input is a zero length string then URL_Encode will return a zero length string. **]**
22 URL_Encode will encode input in a manner that respects the encoding used in the .net HttpUtility.UrlEncode.