diff options
Diffstat (limited to 'libmariadb/man/mysql_get_socket.3')
| -rw-r--r-- | libmariadb/man/mysql_get_socket.3 | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_get_socket.3 b/libmariadb/man/mysql_get_socket.3 new file mode 100644 index 00000000..a68e5e4f --- /dev/null +++ b/libmariadb/man/mysql_get_socket.3 @@ -0,0 +1,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] |