mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 08:47:17 +01:00
34 lines
808 B
Groff
34 lines
808 B
Groff
.\" Automatically generated by Pandoc 2.5
|
|
.\"
|
|
.TH "mysql_get_socket" "3" "" "Version 3.2.2" "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]
|