From 26e703e68a0324e7e5bfd3442f3e424c88dd2c42 Mon Sep 17 00:00:00 2001 From: Aleksey Veresov Date: Fri, 8 Jan 2021 00:43:37 +0300 Subject: Documentation update started. --- man/magi_request_param.3 | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 man/magi_request_param.3 (limited to 'man/magi_request_param.3') diff --git a/man/magi_request_param.3 b/man/magi_request_param.3 new file mode 100644 index 0000000..3b5fb58 --- /dev/null +++ b/man/magi_request_param.3 @@ -0,0 +1,29 @@ +.TH MAGI_REQUEST_PARAM 3 2021-01-07 v0.0.1 "Magi Library Manual" +.SH NAME +.BR magi_request_param , +.B magi_request_urlparam +\- get a parameter from request +.SH SYNOPSIS +.B #include +.P +.RB "char *" magi_request_param "(struct magi_request *" r , +.RB "const char *" name ");" +.P +.RB "char *" magi_request_urlparam "(struct magi_request *" r , +.RB "const char *" name ");" +.SH DESCRIPTION +.BR magi_request_param () +gets the parameter from both request body and URL query, +prioritizing parameters from the body. +.P +.BR magi_request_urlparam () +gets the parameter from URL query. +.SH RETURN VALUE +.BR magi_request_param () +and +.BR magi_request_urlparam () +return value of found parameter with +.I name +as URL-decoded string, or +.B 0 +in case such parameter is not found. -- cgit v1.2.3