[ceph.git] / ceph / src / civetweb / docs / api / mg_get_valid_options.md

# Civetweb API Reference

### `mg_get_valid_options();`

### Parameters

*none*

### Return Value

| Type | Description | 
| :--- | :--- |
|`const struct mg_option *`|An array with all valid configuration options|

### Description

The function `mg_get_valid_options()` returns an array with all valid configuration options of Civetweb. Each element in the array is a structure with three fields which represent the name of the option, the value of the option and the type of the value. The array is terminated with an element for which the name is `NULL`. See for more details about this structure the documentation of [`struct mg_option`](mg_option.md).

### See Also

* [`struct mg_option;`](mg_option.md)
* [`mg_start();`](mg_start.md)
Commit	Line	Data
37b3c998 TL	1	# Civetweb API Reference
	2
	3	### `mg_get_valid_options();`
	4
	5	### Parameters
	6
	7	none
	8
	9	### Return Value
	10
	11	\| Type \| Description \|
	12	\| :--- \| :--- \|
	13	\|`const struct mg_option *`\|An array with all valid configuration options\|
	14
	15	### Description
	16
	17	The function `mg_get_valid_options()` returns an array with all valid configuration options of Civetweb. Each element in the array is a structure with three fields which represent the name of the option, the value of the option and the type of the value. The array is terminated with an element for which the name is `NULL`. See for more details about this structure the documentation of [`struct mg_option`](mg_option.md).
	18
	19	### See Also
	20
	21	* [`struct mg_option;`](mg_option.md)
	22	* [`mg_start();`](mg_start.md)