1
0
mirror of https://github.com/mariadb-corporation/mariadb-connector-c.git synced 2025-08-08 14:02:17 +03:00
Files
mariadb-connector-c/man/mariadb_reconnect.3
Georg Richter 10c67ee835 Man page fixes:
- Install created man pages when building with WITH_DOCS=ON
- Set version to 3.4
2024-10-25 10:37:47 +02:00

30 lines
869 B
Groff

.\" Automatically generated by Pandoc 3.5
.\"
.TH "mariadb_reconnect" "3" "" "Version 3.4" "MariaDB Connector/C"
.SS Name
mariadb_reconnect \- reconnects to a server
.SS Synopsis
.IP
.EX
#include \f[B]<mysql.h>\f[R]
my_bool mariadb_reconnect(MYSQL * mysql)
.EE
.SS Description
\f[CR]mariadb_reconnect()\f[R] tries to reconnect to a server in case
the connection died due to timeout or other errors.
It uses the same credentials which were specified in
\f[B]mysql_real_connect(3)\f[R].
.SS Return value
The function will return 0 on success, a non zero value on error
.PP
\f[B]Note\f[R]: The function will return an error, if the option
\f[CR]MYSQL_OPT_RECONNECT\f[R] wasn\[cq]t set before.
.SS History
\f[CR]mariadb_reconnect()\f[R] was added in MariaDB Connector/C 3.0
.SS See also
.IP \[bu] 2
\f[B]mysql_real_connect(3)\f[R]
.IP \[bu] 2
\f[B]mysql_optionsv(3)\f[R]