From 5727bbb99921a741ee7203a070f580a026f37bc8 Mon Sep 17 00:00:00 2001 From: Shankho Boron Ghosh Date: Mon, 30 Nov 2020 03:44:47 +0530 Subject: Added AFB Helper Guide in Developer Guides Revised and added AFB Helper Guide as a part of Developer Guides. Bug-AGL: [SPEC-3633] Signed-off-by: Shankho Boron Ghosh Change-Id: I3df9265ae0570e987d80bc4bd2d3d14e7743b26a --- .../4_AFB_Helper_Guide/4_URL_Escaping.md | 39 ++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/3_Developer_Guides/4_AFB_Helper_Guide/4_URL_Escaping.md (limited to 'docs/3_Developer_Guides/4_AFB_Helper_Guide/4_URL_Escaping.md') diff --git a/docs/3_Developer_Guides/4_AFB_Helper_Guide/4_URL_Escaping.md b/docs/3_Developer_Guides/4_AFB_Helper_Guide/4_URL_Escaping.md new file mode 100644 index 0000000..4070acb --- /dev/null +++ b/docs/3_Developer_Guides/4_AFB_Helper_Guide/4_URL_Escaping.md @@ -0,0 +1,39 @@ +--- +title: Escaping helpers functions +--- + +## char *escape_url(const char *base, const char *path, const char * const *args, size_t *length) + +Escape an `url` and `arguments` and returned it as a string. + +* `base`: representing the FQDN of the url. +* `path`: the path to the requested page. +* `args`: optionnal array of arguments provided for the GET request. +* `length`: length of the returned `url`. + +Returns the escaped `url`. + +## const char *escape_args(const char * const *args, size_t *length) + +Escape an array of arguments and returned the lenght of the escaped arguments +string. + +* `args`: array of arguments provided for the GET request. +* `length`: length of the returned `arguments`. + +Returns the escaped `arguments`. + +## const char *escape_str(const char *str, size_t *length) + +Escape a string and returns it. + +* `str`: the string to escape. +* `length`: length of the returned string. + +Returns the escaped string. + +## const char **unescape_args(const char *args) + +Unescape an argument and returns it. + +* `args`: the argument to unescape. -- cgit 1.2.3-korg