ceph/src/civetweb/docs/api/mg_get_system_info.md

   1 # Civetweb API Reference
   2
   3 ### `mg_get_system_info( buffer, buflen );`
   4
   5 ### Parameters
   6
   7 | Parameter | Type | Description |
   8 | :--- | :--- | :--- |
   9 |**`buffer**|`char *`|A string buffer to store the information|
  10 |**`buflen**|`int`|Size of the string buffer (including space for a terminating 0)|
  11
  12 ### Return Value
  13
  14 | Type | Description |
  15 | :--- | :--- |
  16 |`int`|Available system information in bytes (excluding the terminating 0)|
  17
  18 ### Description
  19
  20 The function `mg_get_system_info()` returns information collected for the system
  21 (operating system, compiler, version, ...).
  22 Currently this data is returned as string is in JSON format, but changes to the
  23 format are possible in future versions.  The exact content of the JSON object may vary,
  24 depending on the operating system and server version.
  25 This string should be included for support requests.
  26
  27 ### See Also
  28
  29 * [`mg_get_context_info();`](mg_get_context_info.md)
  30