Skip to main content

DB_GetMemHandle

Description

The function gets the memory handle for a SQLite database connection that was opened with DB_Open.

NameDescription
DB:dbThe index of the database connection (returned by DB_Open).

Returns

Returns the memory handle of the database connection handle.

Examples

static DB:gDBConnectionHandle;

// ...

public OnGameModeInit()
{
// ...

// Create a connection to a database
gDBConnectionHandle = DB_Open("example.db");

// If connection to the database exists
if (gDBConnectionHandle)
{
// Successfully created a connection to the database
print("Successfully created a connection to database \"example.db\".");
printf("Database connection memory handle: 0x%x", DB_GetMemHandle(gDBConnectionHandle));
}
else
{
// Failed to create a connection to the database
print("Failed to open a connection to database \"example.db\".");
}

// ...

return 1;
}

public OnGameModeExit()
{
// Close the connection to the database if connection is open
if (DB_Close(gDBConnectionHandle))
{
// Extra cleanup
gDBConnectionHandle = DB:0;
}

// ...

return 1;
}

Notes

warning

Using an invalid handle other than zero will crash your server! Get a valid database connection handle by using DB_ExecuteQuery.