summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_get_socket.3
blob: a68e5e4fab4cea8a8ce4aabd6265cc9f7c43435a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_get_socket" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_get_socket \- Returns the descriptor of the socket used for the
current connection
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>

my_socket mysql_get_socket(MYSQL * mysql);
\f[R]
.fi
.SS Description
.PP
Returns the descriptor of the socket used for the current connection.
.SS Parameter
.IP \[bu] 2
\f[C]mysql\f[R] \- a mysql handle, which was previously allocated by
\f[B]mysql_init(3)\f[R] and connected by
\f[B]mysql_real_connect(3)\f[R].
.SS Return value
.PP
A socket handle or INVALID_SOCKET (\-1) if the socket descriptor could
not be determined, e.g.\ if the connection doesn\[cq]t use a socket
connection.
.SS See also
.IP \[bu] 2
\f[B]mysql_real_connect(3)\f[R]