summaryrefslogtreecommitdiffstats
path: root/src/civetweb/docs/api/mg_get_system_info.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/civetweb/docs/api/mg_get_system_info.md')
-rw-r--r--src/civetweb/docs/api/mg_get_system_info.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_get_system_info.md b/src/civetweb/docs/api/mg_get_system_info.md
new file mode 100644
index 00000000..6add98d5
--- /dev/null
+++ b/src/civetweb/docs/api/mg_get_system_info.md
@@ -0,0 +1,30 @@
+# Civetweb API Reference
+
+### `mg_get_system_info( buffer, buflen );`
+
+### Parameters
+
+| Parameter | Type | Description |
+| :--- | :--- | :--- |
+|**`buffer**|`char *`|A string buffer to store the information|
+|**`buflen**|`int`|Size of the string buffer (including space for a terminating 0)|
+
+### Return Value
+
+| Type | Description |
+| :--- | :--- |
+|`int`|Available system information in bytes (excluding the terminating 0)|
+
+### Description
+
+The function `mg_get_system_info()` returns information collected for the system
+(operating system, compiler, version, ...).
+Currently this data is returned as string is in JSON format, but changes to the
+format are possible in future versions. The exact content of the JSON object may vary,
+depending on the operating system and server version.
+This string should be included for support requests.
+
+### See Also
+
+* [`mg_get_context_info();`](mg_get_context_info.md)
+