diff options
Diffstat (limited to 'libmariadb/man/mysql_shutdown.3')
| -rw-r--r-- | libmariadb/man/mysql_shutdown.3 | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_shutdown.3 b/libmariadb/man/mysql_shutdown.3 new file mode 100644 index 00000000..b91687f0 --- /dev/null +++ b/libmariadb/man/mysql_shutdown.3 @@ -0,0 +1,41 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "mysql_shutdown" "3" "" "Version 3.3.1" "MariaDB Connector/C" +.hy +.SS Name +.PP +mysql_shutdown \- Sends shutdown message to server +.SS Synopsis +.IP +.nf +\f[C] +#include <mysql.h> + +int mysql_shutdown(MYSQL * mysql, + enum mysql_enum_shutdown_level); +\f[R] +.fi +.SS Description +.PP +This function is deprecated. +Instead please use SQL \f[C]SHUTDOWN\f[R] command. +.PP +Sends a shutdown message to the server. +.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]. +.IP \[bu] 2 +\f[C]mysql_enum_shutdown_level\f[R] \- currently only one shutdown +level, \f[C]SHUTDOWN_DEFAULT\f[R] is supported. +.SS Notes +.IP \[bu] 2 +To shutdown the database server, the user for the current connection +must have SHUTDOWN privileges. +.SS Return value +.PP +Returns zero on success, non\-zero on failure. +.SS See also +.IP \[bu] 2 +\f[B]mysql_kill(3)\f[R] |