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

# Civetweb API Reference

### `mg_get_user_connection_data( conn );`

### Parameters

| Parameter | Type | Description |
| :--- | :--- | :--- |
|**`conn`**|`const struct mg_connection *`|The connection for which to return the user data|

### Return Value

| Type | Description | 
| :--- | :--- |
|`void *`|A pointer to the user data, or NULL if no user data was registered with the connection|

### Description

The function `mg_get_user_connection_data()` returns the user data associated with a connection. This user data is represented with a pointer which has been prevously registered with a call to [`mg_set_user_connection_data();`](mg_set_user_connection_data.md). With this function it is possible to pass state information between callback functions refering to a specific connection.

### See Also

* [`mg_set_user_connection_data();`](mg_set_user_connection_data.md)
Commit	Line	Data
11fdf7f2 TL	1	# Civetweb API Reference
	2
	3	### `mg_get_user_connection_data( conn );`
	4
	5	### Parameters
	6
	7	\| Parameter \| Type \| Description \|
	8	\| :--- \| :--- \| :--- \|
	9	\|`conn`\|`const struct mg_connection *`\|The connection for which to return the user data\|
	10
	11	### Return Value
	12
	13	\| Type \| Description \|
	14	\| :--- \| :--- \|
	15	\|`void *`\|A pointer to the user data, or NULL if no user data was registered with the connection\|
	16
	17	### Description
	18
	19	The function `mg_get_user_connection_data()` returns the user data associated with a connection. This user data is represented with a pointer which has been prevously registered with a call to [`mg_set_user_connection_data();`](mg_set_user_connection_data.md). With this function it is possible to pass state information between callback functions refering to a specific connection.
	20
	21	### See Also
	22
	23	* [`mg_set_user_connection_data();`](mg_set_user_connection_data.md)