]> git.proxmox.com Git - ceph.git/blame - ceph/src/civetweb/docs/api/mg_get_request_info.md
import 12.2.13 release
[ceph.git] / ceph / src / civetweb / docs / api / mg_get_request_info.md
CommitLineData
37b3c998
TL
1# Civetweb API Reference
2
3### `mg_get_request_info( conn );`
4
5### Parameters
6
7| Parameter | Type | Description |
8| :--- | :--- | :--- |
9|**`conn`**|`const struct mg_connection *`|The connection for which the request info is needed|
10
11### Return Value
12
13| Type | Description |
14| :--- | :--- |
15|`const struct mg_request_info *`|Pointer to the requested info, or NULL if an error occured|
16
17### Description
18
19The function `mg_get_request_info()` returns information about the request on a given connection. This information is returned as a pointer to a [`mg_request_info`](mg_request_info.md) structure. If an error occurs, a NULL pointer is returned instead.
20
21Use this function when implementing a server.
22
23### See Also
24
25* [`struct mg_request_info;`](mg_request_info.md)
26* [`mg_get_response_info();`](mg_get_response_info.md)
27* [`struct mg_response_info;`](mg_response_info.md)
28