Modules/MySQL/MysqlDestroy: Difference between revisions

Latest revision as of 20:49, 29 September 2009

	This function is provided by the external module MySQL. You must install this module to use this function.

This functions destroys a mysql object (gracefully), and cleans up any data it used.

nil mysqlClose ( mysql mysqlobj )

None

@@ Line 1: / Line 1: @@
 __NOTOC__
-==Description==
+{{ModuleFunction|MySQL}}
-This functions closes the MySQL connection that is currently opened, if there is one.
-This function is provided by the '''ml_mysql''' module.
+This functions destroys a mysql object (gracefully), and cleans up any data it used.
 ==Syntax==
- bool mysqlClose ()
+<syntaxhighlight lang="lua">nil mysqlClose ( mysql mysqlobj )</syntaxhighlight>
 ===Required Arguments===
+*'''mysqlobj''' : The [[mysql]] object created by [[Modules/MySQL/MysqlCreate|mysqlCreate]]
-''None''
 ===Optional Arguments===
 ''None''
-==Example==
- function onMySQLOpen ( result )
-   if ( result )
-     -- do something useful.
-     mysqlClose ();
-   else
-     -- panic.
-   end
- end
- <...>
- mysqlOpen ( onMySQLOpen, "localhost", "user123", "mypassword", "testdatabase", 3306 );