diff options
author | Aleksey Veresov <aleksey@veresov.pro> | 2021-01-08 00:43:37 +0300 |
---|---|---|
committer | Aleksey Veresov <aleksey@veresov.pro> | 2021-01-08 00:43:37 +0300 |
commit | 26e703e68a0324e7e5bfd3442f3e424c88dd2c42 (patch) | |
tree | 59302c86415f72fd48cf53c74489ea39c6df7153 /man/magi_request_param.3 | |
parent | 7d0b4ad61ee1e150c76b9997971582066529b72a (diff) | |
download | magi-26e703e68a0324e7e5bfd3442f3e424c88dd2c42.tar magi-26e703e68a0324e7e5bfd3442f3e424c88dd2c42.tar.xz magi-26e703e68a0324e7e5bfd3442f3e424c88dd2c42.zip |
Documentation update started.
Diffstat (limited to 'man/magi_request_param.3')
-rw-r--r-- | man/magi_request_param.3 | 29 |
1 files changed, 29 insertions, 0 deletions
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 <magi/request.h> +.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. |