diff options
Diffstat (limited to 'src/civetweb/docs/api/mg_start_thread.md')
-rw-r--r-- | src/civetweb/docs/api/mg_start_thread.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_start_thread.md b/src/civetweb/docs/api/mg_start_thread.md new file mode 100644 index 00000000..e8172265 --- /dev/null +++ b/src/civetweb/docs/api/mg_start_thread.md @@ -0,0 +1,26 @@ +# Civetweb API Reference + +### `mg_start_thread( func, cbdata );` + +### Parameters + +| Parameter | Type | Description | +| :--- | :--- | :--- | +|**`func`**|`mg_thread_func_t`|Function to start as a separate thread| +|**`cbdata`**|`void *`|User defined data to be passed to the thread as parameter| + +`void mg_thread_func_t( void *cbdata );` + +### Return Value + +| Type | Description | +| :--- | :--- | +|`int`|Success or error code| + +### Description + +The function `mg_start_thread()` is a convenience function to create a detached thread. The function returns **0** when successful and another value if an error occured. A pointer to user supplied data can be passed which is then passed further on to the thread function as parameter. + +### See Also + +* [`mg_start();`](mg_start.md) |