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