Squirrel/Server/Functions/SQLite/sqlite free
From Liberty Unleashed Wiki
(Difference between revisions)
(Created page with '{{Squirrel/Title|sqlite_free}} {{RequiresModule|lu_sqlite|Modules/Squirrel/lu_sqlite}} This function frees a previously used query struct. This function should always be used aft…') |
|||
Line 13: | Line 13: | ||
== Example == | == Example == | ||
− | + | This will free the carried out query from the memory when 'free' is type into the server console. | |
− | + | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
− | - | + | function onScriptLoad() |
+ | { | ||
+ | LoadModule( "lu_sqlite" ); | ||
+ | pSQDatabase <- sqlite_open( "database.sqlite" ); | ||
+ | |||
+ | return 1; | ||
+ | } | ||
+ | |||
+ | function onConsoleInput( szCommand, szText ) | ||
+ | { | ||
+ | if ( szCommand == "free" ) | ||
+ | { | ||
+ | local query = sqlite_query( pSQDatabase, "SELECT Foo FROM Bar WHERE FooBar='" + szText + "'" ); | ||
+ | sqlite_free( query ); | ||
+ | } | ||
+ | |||
+ | return 1; | ||
+ | } | ||
</code> | </code> | ||
=== Notes === | === Notes === | ||
− | + | The function [[Squirrel/Server/Functions/Scripts/LoadModule|LoadModule]] and [[Squirrel/Server/Functions/SQLite/sqlite_open|sqlite_open]] and and event [[Squirrel/Server/Events/Misc/onScriptLoad|onScriptLoad]] and [[Squirrel/Server/Events/Misc/onConsoleInput|onConsoleInput]] were used in this example. More info about them in the corresponding pages. | |
For a larger example, check the [[Squirrel/Examples/SQLite|SQLite database example]] from the wiki tutorials. | For a larger example, check the [[Squirrel/Examples/SQLite|SQLite database example]] from the wiki tutorials. |
Revision as of 17:01, 25 October 2010
Note: This function requires the external module lu_sqlite.
This function frees a previously used query struct. This function should always be used after the query result has been processed to avoid any memory leaks.
Syntax
bool sqlite_free( UserPointer result )
Arguments
- result - This is a pointer to a result struct retrieved from sqlite_query or sqlite_next_row
Example
This will free the carried out query from the memory when 'free' is type into the server console.
function onScriptLoad() { LoadModule( "lu_sqlite" ); pSQDatabase <- sqlite_open( "database.sqlite" ); return 1; } function onConsoleInput( szCommand, szText ) { if ( szCommand == "free" ) { local query = sqlite_query( pSQDatabase, "SELECT Foo FROM Bar WHERE FooBar='" + szText + "'" ); sqlite_free( query ); } return 1; }
Notes
The function LoadModule and sqlite_open and and event onScriptLoad and onConsoleInput were used in this example. More info about them in the corresponding pages.
For a larger example, check the SQLite database example from the wiki tutorials.
Related Functions
These functions are provided by the official module lu_sqlite.