1
0
mirror of https://github.com/mariadb-corporation/mariadb-connector-c.git synced 2025-04-18 21:24:07 +03:00
mariadb-connector-c/man/mysql_get_socket.3
2024-10-25 07:38:00 +02:00

28 lines
789 B
Groff

.\" Automatically generated by Pandoc 3.5
.\"
.TH "mysql_get_socket" "3" "" "Version 3.3" "MariaDB Connector/C"
.SS Name
mysql_get_socket \- Returns the descriptor of the socket used for the
current connection
.SS Synopsis
.IP
.EX
#include \f[B]<mysql.h>\f[R]
my_socket mysql_get_socket(MYSQL * mysql);
.EE
.SS Description
Returns the descriptor of the socket used for the current connection.
.SS Parameter
.IP \[bu] 2
\f[CR]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
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]