Db close

From SA-MP Wiki

Jump to: navigation, search

db_close

Description:

Closes an SQLite database that was opened with db_open.


Parameters:
(DB:db)
DB:dbThe handle of the database connection to close (returned by db_open).


Return Values:

  • 1: The function executed successfully.
  • 0: The function failed to execute. May mean that the database handle specified is not open.


Image:32px-Circle-style-warning.png

Warning

Using an invalid handle will crash your server! Get a valid handle by using db_open. But it's protected against NULL references.


Example Usage:

new DB:db_handle;
// ...
public OnGameModeInit()
{
	// Create a connection to the database
	if((db_handle = db_open("example.db")) == DB:0)
	{
		// Error
		print("Failed to open a connection to \"example.db\".");
		SendRconCommand("exit");
	}
	else
	{
		// Success
		print("Successfully created a connection to \"example.db\".");
	}
	// ...
	return 1;
}
 
public OnGameModeExit()
{
	// Close the connection to the database
	db_close(db_handle);
	// ...
	return 1;
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.


  • db_open: Open a connection to an SQLite database
  • db_close: Close the connection to an SQLite database
  • db_field_name: Returns the name of a field at a particular index
  • db_get_field: Get content of field with specified ID from current result row
  • db_get_field_int: Get content of field as an integer with specified ID from current result row
  • db_get_field_float: Get content of field as a float with specified ID from current result row
In other languages