eukara
/
WebSurf
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

URL escape: Improve API documentation.

This commit is contained in:
Michael Drake 2016-07-24 21:08:05 +01:00
parent a122b94efd
commit 0c7649d030
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
utils/url.h
View File

@ -31,10 +31,12 @@
/**
* Escape a string suitable for inclusion in an URL.
*
* \param unescaped the unescaped string
* \param sptoplus true iff spaces should be converted to +
* \param escexceptions NULL or a string of characters excluded to be escaped
* \param result pointer to pointer to buffer to hold escaped string
* \param[in] unescaped the unescaped string
* \param[in] sptoplus true iff spaces should be converted to +
* \param[in] escexceptions NULL or a string of characters to be excluded
* from escaping.
* \param[out] result Returns pointer to buffer to escaped string.
* Returned string is '\0' terminated.
* \return NSERROR_OK on success
*/
nserror url_escape(const char *unescaped, bool sptoplus,