You've already forked mariadb-connector-c
mirror of
https://github.com/mariadb-corporation/mariadb-connector-c.git
synced 2025-08-08 14:02:17 +03:00
36 lines
996 B
Groff
36 lines
996 B
Groff
.\" Automatically generated by Pandoc 3.5
|
|
.\"
|
|
.TH "mysql_shutdown" "3" "" "Version 3.3" "MariaDB Connector/C"
|
|
.SS Name
|
|
mysql_shutdown \- Sends shutdown message to server
|
|
.SS Synopsis
|
|
.IP
|
|
.EX
|
|
#include \f[B]<mysql.h>\f[R]
|
|
|
|
int mysql_shutdown(MYSQL * mysql,
|
|
\f[B]enum\f[R] mysql_enum_shutdown_level);
|
|
.EE
|
|
.SS Description
|
|
This function is deprecated.
|
|
Instead please use SQL \f[CR]SHUTDOWN\f[R] command.
|
|
.PP
|
|
Sends a shutdown message to the server.
|
|
.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].
|
|
.IP \[bu] 2
|
|
\f[CR]mysql_enum_shutdown_level\f[R] \- currently only one shutdown
|
|
level, \f[CR]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
|
|
Returns zero on success, non\-zero on failure.
|
|
.SS See also
|
|
.IP \[bu] 2
|
|
\f[B]mysql_kill(3)\f[R]
|