summaryrefslogtreecommitdiffstats
path: root/src/civetweb/docs/api/mg_cry.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/civetweb/docs/api/mg_cry.md')
-rw-r--r--src/civetweb/docs/api/mg_cry.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_cry.md b/src/civetweb/docs/api/mg_cry.md
new file mode 100644
index 00000000..0cf45c9b
--- /dev/null
+++ b/src/civetweb/docs/api/mg_cry.md
@@ -0,0 +1,23 @@
+# Civetweb API Reference
+
+### `mg_cry( conn, fmt, ... );`
+
+### Parameters
+
+| Parameter | Type | Description |
+| :--- | :--- | :--- |
+|**`conn`**|`const struct mg_connection *`|The connection on which a problem occured|
+|**`fmt`**|`const char *`|Format string without a line return|
+|**`...`**|*various*|Parameters depending on the format string|
+
+### Return Value
+
+*none*
+
+### Description
+
+The function `mg_cry()` is called when something happens on a connection. The function takes a format string similar to the `printf()` series of functions with parameters and creates a text string which can then be used for logging. The `mg_cry()` function prints the output to the opened error log stream. Log messages can be processed with the `log_message()` callback function specified in the `struct mg_callbacks` structure.
+
+### See Also
+
+* [`struct mg_callbacks;`](mg_callbacks.md)