ceph/src/jaegertracing/opentelemetry-cpp/third_party/prometheus-cpp/3rdparty/civetweb/docs/api/mg_send_http_error.md

   1 # Civetweb API Reference
   2
   3 ### `mg_send_http_error( conn, status_code, fmt, ... );`
   4
   5 ### Parameters
   6
   7 | Parameter | Type | Description |
   8 | :--- | :--- | :--- |
   9 |**`conn`**|`struct mg_connection *`|The connection over which the data must be sent|
  10 |**`status_code`**|`int`|The HTTP status code (see HTTP standard)|
  11 |**`fmt`**|`const char *`|Format string for an error message|
  12 |**`...`**|*various*|Parameters as specified in the format string|
  13
  14 ### Return Value
  15
  16 | Type | Description |
  17 |`int`| An integer indicating success (>=0) or failure (<0) |
  18
  19
  20 ### Description
  21
  22 The function `mg_send_http_error()` can be used to send HTTP error messages from a server to a client.
  23 The `status_code` must be one of the predefined HTTP standard error codes (e.g., "404" for "Not Found").
  24 The status text (e.g., "Not Found") for standard error codes is known by this function.
  25 A body of the error message, to explain the error in more detail, can be specified using the `fmt` format specifier and additional arguments. The `fmt` format specifier works like for the `printf()` function in the standard C library.
  26
  27
  28 ### See Also
  29
  30 * [`mg_send_http_ok();`](mg_send_http_ok.md)
  31 * [`mg_send_http_redirect();`](mg_send_http_redirect.md)
  32