diff options
Diffstat (limited to 'src/civetweb/docs/api/mg_get_option.md')
| -rw-r--r-- | src/civetweb/docs/api/mg_get_option.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_get_option.md b/src/civetweb/docs/api/mg_get_option.md new file mode 100644 index 00000000..b731dd74 --- /dev/null +++ b/src/civetweb/docs/api/mg_get_option.md @@ -0,0 +1,24 @@ +# Civetweb API Reference + +### `mg_get_option( ctx, name );` + +### Parameters + +| Parameter | Type | Description | +| :--- | :--- | :--- | +|**`ctx`**|`const struct mg_context *`| A pointer to the webserver context | +|**`name`**|`const char *`| The name of the option to query | + +### Return Value + +| Type | Description | +| :--- | :--- | +|`const char *`| A pointer to the option value in text, or NULL if an error occured | + +### Description + +When starting the CivetWeb webserver, options are provided to set the wanted behaviour of the server. The options which were used during startup can be queried through the `mg_get_option()` function. Options are read-only and cannot be changed while the webserver is running. The function returns a pointer to a text string containing the value of the queried option, or NULL if an error occured. It is guaranteed however that if a valid option name is provided as a parameter to this function, that a pointer to a string is returned and not NULL. In case an option was empty or NULL during initialisation, `mg_get_option()` will return a pointer to an empty string. + +### See Also + +* [`mg_start();`](mg_start.md) |