Skip to main content

DB_GetLegacyDBResult

Description​

The function gets the memory handle for a SQLite database result set that was allocated with DB_ExecuteQuery.

NameDescription
DBResult:resultThe index of the query (returned by DB_ExecuteQuery).

Returns​

Returns the memory handle of the database result set 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
        new DBResult:result_set = DB_ExecuteQuery("SELECT * FROM `examples`");
        print("Successfully created a connection to database \"example.db\".");
        if (result_set)
        {
            printf("Database connection memory handle: 0x%x", DB_GetLegacyDBResult(result_set));
            DB_FreeResultSet(result_set);
        }
    }
    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.